Skip to content

fixed readme.md for imas #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
olivhoenen merged 3 commits into from
Jan 15, 2025
Merged

fixed readme.md for imas #3

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c42a139
fixed readme.md for imas
gautamraj8044 Dec 13, 2024
c0f2ca0
Apply suggestion on naming
olivhoenen Dec 17, 2024
a9be87e
Update README.md
gautamraj8044 Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# IMASPy
# IMAS-Python

IMASPy is a pure-python library to handle arbitrarily nested data structures.
IMASPy is designed for, but not necessarily bound to, interacting with Interface
IMAS-Python is a pure-python library to handle arbitrarily nested data structures.
It is designed for, but not necessarily bound to, interacting with Interface
Data Structures (IDSs) as defined by the Integrated Modelling & Analysis Suite (IMAS)
Data Model.

Expand All @@ -11,7 +11,7 @@ Data Model.
Install steps are described in the documentation generated from `/docs/source/installing.rst`.

Documentation is autogenerated from the source using [Sphinx](http://sphinx-doc.org/)
and can be found at the [ITER sharepoint](https://sharepoint.iter.org/departments/POP/CM/IMDesign/Code%20Documentation/IMASPy-doc/index.html)
and can be found at the [ITER sharepoint](https://sharepoint.iter.org/departments/POP/CM/IMDesign/Code%20Documentation/IMAS-doc/index.html)
Copy link
Collaborator

@olivhoenen olivhoenen Dec 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pending a new open access URL for the documentation.


The documentation can be manually generated by installing sphinx and running:

Expand All @@ -23,15 +23,15 @@ make -C docs html
## How to use

```python
import imaspy
factory = imaspy.IDSFactory()
import imas
factory = imas.IDSFactory()
equilibrium = factory.equilibrium()
print(equilibrium)

equilibrium.ids_properties.homogeneous_time = imaspy.ids_defs.IDS_TIME_MODE_HETEROGENEOUS
equilibrium.ids_properties.homogeneous_time = imas.ids_defs.IDS_TIME_MODE_HETEROGENEOUS
equilibrium.ids_properties.comment = "testing"

with imaspy.DBEntry("imas:hdf5?path=./testdb","w") as dbentry:
with imas.DBEntry("imas:hdf5?path=./testdb","w") as dbentry:
dbentry.put(equilibrium)
```

Expand All @@ -40,7 +40,7 @@ A quick 5 minutes introduction is available in the documentation generated from

## Legal

IMASPy is Copyright 2020-2024 ITER Organization, Copyright 2020-2023 Karel Lucas van de
IMAS-Python is Copyright 2020-2024 ITER Organization, Copyright 2020-2023 Karel Lucas van de
Plassche <karelvandeplassche@gmail.com>, Copyright 2020-2022 Daan van Vugt <dvanvugt@ignitioncomputing.com>,
and Copyright 2020 Dutch Institute for Fundamental Energy Research <info@differ.nl>.
It is licensed under [LGPL 3.0](LICENSE.txt).
Expand Down