From 245651b2c7c026a2ca313cd2350f88bbfc625bb5 Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Wed, 27 Aug 2025 13:29:59 -0400 Subject: [PATCH 1/5] add new installation instructions for packs --- docs/source/getting-started.rst | 59 ++++++++++++++++++++++++++++++++- 1 file changed, 58 insertions(+), 1 deletion(-) diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst index 3571c5c..36b3a73 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 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 ----------------- From 5363826832459cee8849f02eecb24dca99adda31 Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Wed, 27 Aug 2025 13:30:24 -0400 Subject: [PATCH 2/5] news --- news/update-installation.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 news/update-installation.rst 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:** + +* From a7008a2429e187ba3afa59627100d53dab0b6d9c Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Wed, 27 Aug 2025 13:32:27 -0400 Subject: [PATCH 3/5] typo --- docs/source/getting-started.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst index 36b3a73..4455092 100644 --- a/docs/source/getting-started.rst +++ b/docs/source/getting-started.rst @@ -46,7 +46,7 @@ To install using ``pip`` into your ``diffpy.cmi_env`` environment, type pip install diffpy.cmi -Pack Installation +Pack and Profile Installation ----------------- Use the `cmi` command-line interface to install and manage modular optional dependencies, known as `packs`, From d94e2cb1701d48b9d03196b3bc197cac6e841e6d Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Wed, 27 Aug 2025 13:48:30 -0400 Subject: [PATCH 4/5] change readme so it renders on pypi properly --- README.rst | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) 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) From c4b589fc4c547397a169b24fbefefb479f6e15cd Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Wed, 27 Aug 2025 15:54:03 -0400 Subject: [PATCH 5/5] another typo --- docs/source/getting-started.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst index 4455092..3277cd8 100644 --- a/docs/source/getting-started.rst +++ b/docs/source/getting-started.rst @@ -47,7 +47,7 @@ To install using ``pip`` into your ``diffpy.cmi_env`` environment, type 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,