Skip to content

Commit ea22821

Browse files
committed
add conda instructions. Tidy up and new badges.
1 parent 429a6cb commit ea22821

File tree

1 file changed

+32
-7
lines changed

1 file changed

+32
-7
lines changed

README.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,41 @@
11
<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+
/>
410
</div>
511

6-
[![PyPI](https://img.shields.io/pypi/v/multidimio.svg)][pypi_]
7-
[![Status](https://img.shields.io/pypi/status/multidimio.svg)][status]
12+
[![PyPI](https://img.shields.io/pypi/v/multidimio.svg)][install_pip]
13+
[![Conda](https://img.shields.io/conda/vn/conda-forge/multidimio)][install_conda]
814
[![Python Version](https://img.shields.io/pypi/pyversions/multidimio)][python version]
15+
[![Status](https://img.shields.io/pypi/status/multidimio.svg)][status]
916
[![License](https://img.shields.io/pypi/l/multidimio)][license]
1017

11-
[![Read the documentation at https://mdio-python.readthedocs.io/](https://img.shields.io/readthedocs/mdio-python/latest.svg?label=Read%20the%20Docs)][read the docs]
1218
[![Tests](https://github.com/TGSAI/mdio-python/workflows/Tests/badge.svg)][tests]
1319
[![Codecov](https://codecov.io/gh/TGSAI/mdio-python/branch/main/graph/badge.svg)][codecov]
20+
[![Read the documentation at https://mdio-python.readthedocs.io/](https://img.shields.io/readthedocs/mdio-python/latest.svg?label=Read%20the%20Docs)][read the docs]
1421

1522
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
1623
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
1724

25+
[![PyPI Downloads](https://img.shields.io/pypi/dm/multidimio?label=PyPI%20downloads)][pypi_]
26+
[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/multidimio?label=Conda%20downloads&style=flat)][conda-forge_]
27+
1828
[pypi_]: https://pypi.org/project/multidimio/
29+
[conda-forge_]: https://anaconda.org/conda-forge/multidimio
1930
[status]: https://pypi.org/project/multidimio/
2031
[python version]: https://pypi.org/project/multidimio
2132
[read the docs]: https://mdio-python.readthedocs.io/
2233
[tests]: https://github.com/TGSAI/mdio-python/actions?workflow=Tests
2334
[codecov]: https://app.codecov.io/gh/TGSAI/mdio-python
2435
[pre-commit]: https://github.com/pre-commit/pre-commit
2536
[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
2639

2740
**_"MDIO"_** is a library to work with large multidimensional energy datasets.
2841
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.
5972
Simplest way to install _MDIO_ via [pip] from [PyPI]:
6073

6174
```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.
6386
```
6487

65-
For more instructions, please see the [installation instructions][install]
88+
For details, please see the [installation instructions][install]
6689
in the documentation.
6790

6891
# Using MDIO
@@ -112,9 +135,11 @@ template.
112135

113136
[@cjolowicz]: https://github.com/cjolowicz
114137
[pypi]: https://pypi.org/
138+
[conda-forge]: https://conda-forge.org/
115139
[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
116140
[file an issue]: https://github.com/TGSAI/mdio-python/issues
117141
[pip]: https://pip.pypa.io/
142+
[conda]: https://docs.conda.io/
118143
[dask]: https://www.dask.org/
119144
[zarr]: https://zarr.dev/
120145
[fsspec]: https://filesystem-spec.readthedocs.io/en/latest/

0 commit comments

Comments
 (0)