|
1 | | -Scientific Data Format for Python |
2 | | -================================= |
| 1 | +# Scientific Data Format for Python |
3 | 2 |
|
4 | 3 | SDF is a Python package to read, write and interpolate multi-dimensional data. |
5 | | -The Scientific Data Format is an open file format based on HDF5_ to store |
6 | | -multi-dimensional data such as parameters, simulation results or measurements. |
| 4 | +The Scientific Data Format is an open file format based on [HDF5](https://www.hdfgroup.org/hdf5/) to store multi-dimensional data such as parameters, simulation results or measurements. |
7 | 5 | It supports... |
8 | 6 |
|
9 | 7 | - very large files |
10 | 8 | - up to 32 dimensions |
11 | 9 | - hierarchical structure |
12 | 10 | - units, comments and custom meta-information |
13 | 11 |
|
14 | | -For detailed information see the `SDF specification`_. |
| 12 | +For detailed information see the [SDF specification](https://github.com/ScientificDataFormat/SDF). |
15 | 13 |
|
| 14 | +## Installation |
16 | 15 |
|
17 | | -Installation |
18 | | ------------- |
19 | | - |
20 | | -To install the latest release from `PyPI <https://pypi.python.org/pypi/sdf/>`_ or update an existing installation:: |
| 16 | +To install the latest release from [PyPI](https://pypi.python.org/pypi/sdf/) or update an existing installation: |
21 | 17 |
|
22 | 18 | python -m pip install --upgrade sdf |
23 | 19 |
|
24 | | -To install the latest development version:: |
25 | | - |
26 | | - python -m pip install --upgrade https://github.com/ScientificDataFormat/SDF-Python/archive/main.zip |
27 | | - |
28 | | - |
29 | 20 | Tutorial |
30 | 21 | -------- |
31 | 22 |
|
@@ -66,12 +57,12 @@ Get the scale for the first dimension: |
66 | 57 | >>> ds_t2.unit |
67 | 58 | 's' |
68 | 59 |
|
| 60 | +## License |
69 | 61 |
|
70 | | ------------------------------ |
| 62 | +The code is released under the [2-Clause BSD license](LICENSE). |
71 | 63 |
|
72 | | -Copyright |copyright| 2024 |Dassault Systemes| |
| 64 | +--- |
73 | 65 |
|
74 | | -.. _SDF specification: https://github.com/ScientificDataFormat/SDF |
75 | | -.. _HDF5: https://www.hdfgroup.org/hdf5/ |
76 | | -.. |copyright| unicode:: U+000A9 |
77 | | -.. |Dassault Systemes| unicode:: Dassault U+0020 Syst U+00E8 mes |
| 66 | +<p align="center"> |
| 67 | + <a href="https://3ds.com/"><img src="https://github.com/user-attachments/assets/b5bf4274-633f-4a1b-aa03-e84828a686b7"/></a> |
| 68 | +</p> |
0 commit comments