diff --git a/README.rst b/README.rst index dd58989..abfcbd8 100644 --- a/README.rst +++ b/README.rst @@ -92,30 +92,35 @@ Use the `cmi` command-line interface to install and manage modular optional depe and to configure or execute user-defined workflows that combine multiple packs with optional post-installation steps, known as `profiles`. To use `cmi`, you can run the following example commands: + Show available commands and options, + .. code-block:: bash - :caption: Show available commands and options cmi -h +List installed and available packs and profiles, + .. code-block:: bash - :caption: List installed and available packs and profiles cmi pack list cmi profile list +Show details of a specific pack or profile, + .. code-block:: bash - :caption: Show details of a specific pack or profile cmi pack show cmi profile show +Install a pack or profile (by name or path), + .. code-block:: bash - :caption: Install a pack or profile (by name or path) cmi install +List and get installed examples, + .. code-block:: bash - :caption: List and get installed examples cmi example list cmi example (copy) diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst index 3571c5c..3277cd8 100644 --- a/docs/source/getting-started.rst +++ b/docs/source/getting-started.rst @@ -24,12 +24,69 @@ Installation To install ``diffpy.cmi``, create a new conda environment or activate an existing environment and install the package from the conda-forge channel. -.. code-block:: console +.. code-block:: bash conda create -n diffpy.cmi-env conda install -c conda-forge diffpy.cmi conda activate diffpy.cmi-env +To confirm that the installation was successful, type + +.. code-block:: bash + + python -c "import diffpy.cmi; print(diffpy.cmi.__version__)" + +The output should print the latest version. + +If the above does not work, you can use ``pip`` to download and install the latest release from +`Python Package Index `_. +To install using ``pip`` into your ``diffpy.cmi_env`` environment, type + +.. code-block:: bash + + pip install diffpy.cmi + +Pack and Profile Installation +----------------------------- + +Use the `cmi` command-line interface to install and manage modular optional dependencies, known as `packs`, +and to configure or execute user-defined workflows that combine multiple packs with optional post-installation steps, +known as `profiles`. To use `cmi`, you can run the following example commands: + +Show available commands and options with, + +.. code-block:: bash + + cmi -h + +List installed and available packs and profiles, + +.. code-block:: bash + + cmi pack list + cmi profile list + +Show details of a specific pack or profile, + +.. code-block:: bash + + cmi pack show + cmi profile show + +Install a pack or profile (by name or path), + +.. code-block:: bash + + cmi install + cmi install + cmi install + +List and get installed examples, + +.. code-block:: bash + + cmi example list + cmi example (copy) Data and Examples ----------------- diff --git a/news/update-installation.rst b/news/update-installation.rst new file mode 100644 index 0000000..afca515 --- /dev/null +++ b/news/update-installation.rst @@ -0,0 +1,23 @@ +**Added:** + +* Add installation instructions for packs. + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +*