From 833b4a2b77d6bc70b1a7d6717438c837127f49c5 Mon Sep 17 00:00:00 2001 From: shimwell Date: Thu, 10 Oct 2024 23:06:37 +0100 Subject: [PATCH] added pip install --- docs/install.rst | 82 +++++++++++++++++++++++------------------------- 1 file changed, 40 insertions(+), 42 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index 2614ffe0..7439b5c0 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,70 +1,77 @@ Install ======= -Prerequisites -------------- +Paramak is distributed via PyPI and can be installed using pip. -To use of Paramak you will need Python 3 installed using Miniconda or Anaconda, or Miniforge +.. code-block:: bash -* `Miniforge `_ recommended as it includes Mamba -* `Miniconda `_ -* `Anaconda `_ + pip install paramak +.. Prerequisites +.. ------------- -Once you have a version of Mamba or Conda installed then proceed with the Paramak specific steps. +.. To use of Paramak you will need Python 3 installed using Miniconda or Anaconda, or Miniforge +.. * `Miniforge `_ recommended as it includes Mamba +.. * `Miniconda `_ +.. * `Anaconda `_ -Install (mamba) ---------------- -This is the recommended method as it installs all the dependencies and Mamba is faster and requires less RAM than the pure Conda method. -Create a new environment (with your preferred python version). +.. Once you have a version of Mamba or Conda installed then proceed with the Paramak specific steps. -.. code-block:: bash - mamba create --name paramak_env python=3.11 +.. Install (mamba) +.. --------------- +.. This is the recommended method as it installs all the dependencies and Mamba is faster and requires less RAM than the pure Conda method. -Then activate the new environment. +.. Create a new environment (with your preferred python version). -.. code-block:: bash +.. .. code-block:: bash - mamba activate paramak_env +.. mamba create --name paramak_env python=3.11 -Then install the Paramak. +.. Then activate the new environment. -.. code-block:: bash +.. .. code-block:: bash - mamba install -c conda-forge paramak +.. mamba activate paramak_env -Now you should be ready to import paramak from your new python environment. -Install (conda) ---------------- +.. Then install the Paramak. -Create a new environment (with your preferred python version). +.. .. code-block:: bash -.. code-block:: bash +.. mamba install -c conda-forge paramak - conda create --name paramak_env python=3.11 +.. Now you should be ready to import paramak from your new python environment. +.. Install (conda) +.. --------------- -Then activate the new environment. +.. Create a new environment (with your preferred python version). -.. code-block:: bash +.. .. code-block:: bash - conda activate paramak_env +.. conda create --name paramak_env python=3.11 -Then install the Paramak. -.. code-block:: bash +.. Then activate the new environment. + +.. .. code-block:: bash - mamba install -c conda-forge paramak +.. conda activate paramak_env -Now you should be ready to import paramak from your new python environment. +.. Then install the Paramak. + +.. .. code-block:: bash + +.. mamba install -c conda-forge paramak + +.. Now you should be ready to import paramak from your new python environment. @@ -72,20 +79,11 @@ Developer Installation ---------------------- If you want to contribute to the paramak or then you might want to install the -package in a more dynamic manner. +package in a more dynamic manner so that your changes to the code are readily available. Download and install MiniConda, create a new python environment and activate the environment as covered in the installation procedure above. -Then install CadQuery with Conda, Mamba or pip. - -.. code-block:: bash - - conda install -c conda-forge cadquery - mamba install -c conda-forge cadquery - pip install cadquery - - Then clone the repository .. code-block:: bash