|
1 | 1 | <div> |
2 | | - <img src="https://raw.githubusercontent.com/TGSAI/mdio.github.io/gh-pages/assets/images/mdio.png", |
3 | | -width=200"><br> |
| 2 | + <img |
| 3 | + class="logo" |
| 4 | + src="https://raw.githubusercontent.com/TGSAI/mdio.github.io/gh-pages/assets/images/mdio.png" |
| 5 | + alt="MDIO" |
| 6 | + width=200 |
| 7 | + height=auto |
| 8 | + style="margin-top:10px;margin-bottom:10px" |
| 9 | + /> |
4 | 10 | </div> |
5 | 11 |
|
6 | | -[][pypi_] |
7 | | -[][status] |
| 12 | +[][install_pip] |
| 13 | +[][install_conda] |
8 | 14 | [][python version] |
| 15 | +[][status] |
9 | 16 | [][license] |
10 | 17 |
|
11 | | -[][read the docs] |
12 | 18 | [][tests] |
13 | 19 | [][codecov] |
| 20 | +[][read the docs] |
14 | 21 |
|
15 | 22 | [][pre-commit] |
16 | 23 | [][black] |
17 | 24 |
|
| 25 | +[][pypi_] |
| 26 | +[][conda-forge_] |
| 27 | + |
18 | 28 | [pypi_]: https://pypi.org/project/multidimio/ |
| 29 | +[conda-forge_]: https://anaconda.org/conda-forge/multidimio |
19 | 30 | [status]: https://pypi.org/project/multidimio/ |
20 | 31 | [python version]: https://pypi.org/project/multidimio |
21 | 32 | [read the docs]: https://mdio-python.readthedocs.io/ |
22 | 33 | [tests]: https://github.com/TGSAI/mdio-python/actions?workflow=Tests |
23 | 34 | [codecov]: https://app.codecov.io/gh/TGSAI/mdio-python |
24 | 35 | [pre-commit]: https://github.com/pre-commit/pre-commit |
25 | 36 | [black]: https://github.com/psf/black |
| 37 | +[install_pip]: https://mdio-python.readthedocs.io/en/latest/installation.html#using-pip-and-virtualenv |
| 38 | +[install_conda]: https://mdio-python.readthedocs.io/en/latest/installation.html#using-conda |
26 | 39 |
|
27 | 40 | **_"MDIO"_** is a library to work with large multidimensional energy datasets. |
28 | 41 | The primary motivation behind **MDIO** is to represent multidimensional |
@@ -59,10 +72,20 @@ The features marked as **FUTURE** will be open-sourced at a later date. |
59 | 72 | Simplest way to install _MDIO_ via [pip] from [PyPI]: |
60 | 73 |
|
61 | 74 | ```shell |
62 | | -pip install multidimio |
| 75 | +$ pip install multidimio |
| 76 | +``` |
| 77 | + |
| 78 | +or install _MDIO_ via [conda] from [conda-forge]: |
| 79 | + |
| 80 | +```shell |
| 81 | +$ conda install -c conda-forge multidimio |
| 82 | +``` |
| 83 | + |
| 84 | +```{note} |
| 85 | +Extras must be installed separately on `Conda` environments. |
63 | 86 | ``` |
64 | 87 |
|
65 | | -For more instructions, please see the [installation instructions][install] |
| 88 | +For details, please see the [installation instructions][install] |
66 | 89 | in the documentation. |
67 | 90 |
|
68 | 91 | # Using MDIO |
@@ -112,9 +135,11 @@ template. |
112 | 135 |
|
113 | 136 | [@cjolowicz]: https://github.com/cjolowicz |
114 | 137 | [pypi]: https://pypi.org/ |
| 138 | +[conda-forge]: https://conda-forge.org/ |
115 | 139 | [hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python |
116 | 140 | [file an issue]: https://github.com/TGSAI/mdio-python/issues |
117 | 141 | [pip]: https://pip.pypa.io/ |
| 142 | +[conda]: https://docs.conda.io/ |
118 | 143 | [dask]: https://www.dask.org/ |
119 | 144 | [zarr]: https://zarr.dev/ |
120 | 145 | [fsspec]: https://filesystem-spec.readthedocs.io/en/latest/ |
|
0 commit comments