diff --git a/README.md b/README.md index 35c1ae46..d0ded727 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,20 @@ Data Model. ## Install -Install steps are described in the documentation generated from `/docs/source/installing.rst`. +Simply install IMAS-Python with ``pip``: +```bash +pip install imas-python +``` +or with optional dependencies for netCDF and xarray support: +```bash +pip install imas-python[netcdf,xarray] +``` -Documentation is autogenerated from the source using [Sphinx](http://sphinx-doc.org/) +More details are described in the documentation generated from `/docs/source/installing.rst`. +The documentation is autogenerated from the source using [Sphinx](http://sphinx-doc.org/) and can be found at the [readthedocs](https://imas-python.readthedocs.io/en/latest/) -The documentation can be manually generated by installing sphinx and running: - +To generated the documentation yourself, install the ``docs`` optional dependencies and do: ```bash make -C docs html ``` diff --git a/docs/source/installing.rst b/docs/source/installing.rst index 0f2129ca..a843ff6f 100644 --- a/docs/source/installing.rst +++ b/docs/source/installing.rst @@ -13,6 +13,28 @@ To get started, you can install it from `pypi.org