Skip to content

Commit

Permalink
Update github URLs and installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
sayerhs committed Mar 15, 2024
1 parent 0a5b3f3 commit 301ee78
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 9 deletions.
21 changes: 14 additions & 7 deletions docs/source/user/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,6 @@ Install Anaconda
environment to be updated.


.. _install_dev_git:

Install CPL from conda-forge (recommended)
------------------------------------------

Expand All @@ -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
-----------------------

Expand All @@ -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

Expand All @@ -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.

Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/source/user/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://conda.io>`_, or
access the `Git repository <https://bitbucket.org/appliedccm/cpl>`_ hosted on
access the `Git repository <https://github.com/sayerhs/cpl>`_ 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.

Expand Down
2 changes: 1 addition & 1 deletion etc/conda/caelus/meta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 301ee78

Please sign in to comment.