Skip to content

Commit

Permalink
Merge pull request #156 from VirtualPlanetaryLaboratory/dev
Browse files Browse the repository at this point in the history
Dev
  • Loading branch information
RoryBarnes authored May 26, 2021
2 parents 263f93a + ce7393a commit 093f38f
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,24 @@ Installing VPLanet

VPLanet will run on macOS 10+, most recent Linux distributions, and Windows 10
(via their free `Ubuntu Linux interface
<https://www.microsoft.com/en-us/p/ubuntu/9nblggh4msv6?activetab=pivot:overviewtab>``).
<https://www.microsoft.com/en-us/p/ubuntu/9nblggh4msv6?activetab=pivot:overviewtab>`_).
If you plan on developing VPLanet us the Developers


Users
----------

You can install VPLanet and its support scripts (vplot, vspace, multiplanet, and
bigplanet) with a single command line call pip:
bigplanet) using `pip <https://pip.pypa.io/en/stable>`_:

.. code-block:: bash
python -m pip install vplanet
This will place executables of the most up-to-date, stable versions of these
codes in your path (after ensuring all dependency checks are satisfied). This
command will **not** download the repository.
command will **not** download the repository. Please note that VPLanet requires
Python 3.6 or greater.

Developers
----------
Expand All @@ -34,22 +35,20 @@ commands:
cd vplanet
python setup.py develop
After changes to the C source:
After changes to the C source, make sure to re-install:

.. code-block:: bash
python setup.py clean --all
python setup.py develop
XXX Why can't this be a single command??XX
:note::
.. note::

If you are running macOS Catalina or later, you may need to force the operating
system to set the location of C libraries:
If you are running macOS Catalina or later, you may need to force the operating
system to set the location of C libraries:

.. code-block:: bash
.. code-block:: bash
export CPATH=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/usr/include
export CPATH=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/usr/include
Thanks to Chris Colose for identifying and solving this problem.
Thanks to Chris Colose for identifying and solving this problem.

0 comments on commit 093f38f

Please sign in to comment.