pyOpenSci: imporve installation instruct

PetroFit · Feb 27, 2024 · 9851e86 · 9851e86
1 parent a51cbca
commit 9851e86
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 8 deletions.
diff --git a/README.rst b/README.rst
@@ -14,6 +14,11 @@ for installation instructions and a guide to the ``petrofit`` module.
 .. image:: https://github.com/PetroFit/petrofit/raw/main/docs/images/multi_fit.png
     :width: 100%
 
+Installation
+------------
+You can install PetroFit using ``pip install petrofit``. Please see
+the `petrofit documentation <https://petrofit.readthedocs.io/en/latest/>`_ for detailed installation instructions.
+
 License
 -------
 

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -15,14 +15,6 @@ PetroFit can be installed using pip as follows:
 
     pip install petrofit
 
-Before installing PetroFit, you may need to install the required dependencies.
-You can do this using the requirements file located in the top directory of the repository. To do so, navigate to the
-top directory of the PetroFit repository (where the requirements.txt file is located). Then run:
-
-.. code-block:: bash
-
-    pip install -r requirements.txt
-
 Conda
 *****
 
@@ -130,5 +122,13 @@ For developers, we recommend setting up a conda environment and then using the f
 If you will be contributing to the software, we recommend forking the repository on GitHub first, cloning your forked repository,
 and then installing the developer version.
 
+Before installing PetroFit, you may need to install the required dependencies.
+You can do this using the requirements file located in the top directory of the repository. To do so, navigate to the
+top directory of the PetroFit repository (where the requirements.txt file is located). Then run:
+
+.. code-block:: bash
+
+    pip install -r requirements.txt
+
 Frozen versions of conda environment files are provided via the `petrofit_environments repository <https://github.com/PetroFit/petrofit_environments>`_.