Skip to content

Commit

Permalink
DOC added dev install docs (#776)
Browse files Browse the repository at this point in the history
  • Loading branch information
beckermr committed May 5, 2020
1 parent 984b31f commit a8de7e9
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Unreleased

## Python library
-
- Added more developer documentation (#776).

## C library
-
Expand Down
35 changes: 34 additions & 1 deletion readthedocs/source/developer_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To install CCL using a ``pip`` developer installation, you can execute

.. code-block:: bash
$ pip install -e .
$ pip install --no-deps -e .
from the top-level directory in the repository. You will need ``CMake`` in
order to install CCL in this way. See :ref:`getting-cmake` for help installing
Expand Down Expand Up @@ -49,3 +49,36 @@ To uninstall ``CCL`` in developer mode, simply type
.. code-block:: bash
$ pip uninstall pyccl
Boostrapping a CCL Development Environment with ``conda``
=========================================================

One of the easier ways to get started with CCL development is to use
``conda-forge`` to provide the third-party requirements above and the necessary
compilers. The following commands will get you started with a ``conda-forge``-based
development environment. Note that before you start, make sure to follow the
`conda-forge instructions <https://conda-forge.org/docs/user/introduction.html#how-can-i-install-packages-from-conda-forge>`_
for use and that your ``PYTHONPATH`` variable is not set.

Then do the following

.. code-block:: bash
$ conda create -n ccl-dev compilers cmake swig pyccl pytest flake8
$ conda activate ccl-dev
$ conda uninstall pyccl --force
$ git clone https://github.com/LSSTDESC/CCL.git
$ cd CCL
$ pip install --no-deps -e .
This set of commands leaves a copy of the compiled ``C`` extension in the checked out
copy of the code, e.g.,

.. code-block:: bash
$ ls pyccl/*.so
pyccl/_ccllib.so
If you make changes to the ``C`` library or checkout a new branch, simply rerun
``pip install --no-deps -e .`` to rebuild the library.

0 comments on commit a8de7e9

Please sign in to comment.