Skip to content

Commit 2067101

Browse files
authored
Update and rename README.rst to README.md [skip ci]
1 parent df3746a commit 2067101

File tree

1 file changed

+11
-20
lines changed

1 file changed

+11
-20
lines changed

README.rst renamed to README.md

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,22 @@
1-
Scientific Data Format for Python
2-
=================================
1+
# Scientific Data Format for Python
32

43
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.
75
It supports...
86

97
- very large files
108
- up to 32 dimensions
119
- hierarchical structure
1210
- units, comments and custom meta-information
1311

14-
For detailed information see the `SDF specification`_.
12+
For detailed information see the [SDF specification](https://github.com/ScientificDataFormat/SDF).
1513

14+
## Installation
1615

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:
2117

2218
python -m pip install --upgrade sdf
2319

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-
2920
Tutorial
3021
--------
3122

@@ -66,12 +57,12 @@ Get the scale for the first dimension:
6657
>>> ds_t2.unit
6758
's'
6859

60+
## License
6961

70-
-----------------------------
62+
The code is released under the [2-Clause BSD license](LICENSE).
7163

72-
Copyright |copyright| 2024 |Dassault Systemes|
64+
---
7365

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

Comments
 (0)