diff --git a/docs/source/user/installation.rst b/docs/source/user/installation.rst index cdc4c30..8fdd5cf 100644 --- a/docs/source/user/installation.rst +++ b/docs/source/user/installation.rst @@ -52,8 +52,6 @@ Install Anaconda environment to be updated. -.. _install_dev_git: - Install CPL from conda-forge (recommended) ------------------------------------------ @@ -63,6 +61,15 @@ Install CPL from conda-forge (recommended) conda install -c conda-forge caelus +Install using pip +----------------- + +.. code-block:: console + + pip install py-caelus + +.. _install_dev_git: + Install CPL from source ----------------------- @@ -71,8 +78,8 @@ Install CPL from source .. code-block:: console # Change to directory where you want to develop/store sources - git clone https://bitbucket.org/appliedccm/CPL - cd CPL + git clone https://github.com/sayerhs/cpl + cd cpl #. Create a custom conda environment @@ -84,7 +91,7 @@ Install CPL from source .. note:: #. Developers interested in developing CPL might want to install the - development environment available in :file:`etc/caelus2-dev.yml`. This + development environment available in :file:`etc/caelus3-dev.yml`. This installs additional packages like ``sphinx`` for document generation, and ``pytest`` for running the test suite. @@ -124,8 +131,8 @@ Install CPL .. code-block:: console # Change to directory where you want to develop/store sources - git clone https://bitbucket.org/appliedccm/CPL - cd CPL + git clone https://github.com/sayerhs/cpl + cd cpl #. Create a virtual environment with all dependencies for CPL diff --git a/docs/source/user/intro.rst b/docs/source/user/intro.rst index 2ff48a0..1bbdb58 100644 --- a/docs/source/user/intro.rst +++ b/docs/source/user/intro.rst @@ -36,7 +36,7 @@ Usage CPL is distributed under the terms Apache License Version 2.0 open-source license. Users can install the package using `conda `_, or -access the `Git repository `_ hosted on +access the `Git repository `_ hosted on BitBucket. Please follow :ref:`installation` for more details on how to install CPL and its dependencies within an existing Python installation on your system. diff --git a/etc/conda/caelus/meta.yaml b/etc/conda/caelus/meta.yaml index f99a1f1..150d9ea 100644 --- a/etc/conda/caelus/meta.yaml +++ b/etc/conda/caelus/meta.yaml @@ -27,6 +27,6 @@ requirements: - pyvista about: - home: https://bitbucket.org/appliedccm/cpl + home: https://github.com/sayerhs/cpl license: "Apache License 2.0" summmary: Python library for use with Caelus CML and OpenFOAM