Updated documentation, removed MANIFEST.in

tomasstolker · Feb 8, 2020 · 2d37d54 · 2d37d54
1 parent 39a901a
commit 2d37d54
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 59 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/README.rst b/README.rst
@@ -25,7 +25,7 @@
 .. image:: http://img.shields.io/badge/arXiv-1912.13316-orange.svg?style=flat
     :target: https://arxiv.org/abs/1912.13316
 
-*species* is a toolkit for spectral and photometric analysis of planetary and substellar atmospheres. It provides a coherent framework for atmospheric characterization which builds on publicly-available data from various resources such as spectral and photometric libraries, atmospheric models, evolutionary models, photometry of directly imaged planets, and filter transmission curves. All data are stored in a central database and there are tools available for extracting, inspecting, analyzing, and plotting of data, models, and results. The package has been released on `PyPI <https://pypi.org/project/species/>`_ and is actively developed and maintained on Github.
+*species* is a toolkit for atmospheric characterization of exoplanets and brown dwarfs. It provides a coherent framework for atmospheric characterization which builds on publicly-available data from various resources such as spectral and photometric libraries, atmospheric models, evolutionary models, photometry of directly imaged planets, and filter transmission curves. All data are stored in a central database and there are tools available for extracting, inspecting, analyzing, and plotting of data, models, and results. The package has been released on `PyPI <https://pypi.org/project/species/>`_ and is actively developed and maintained on Github.
 
 Documentation
 -------------

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -5,49 +5,13 @@ Installation
 
 *species* is compatible with Python 3.6/3.7 and is available in the |pypi| and on |github|.
 
-Virtual Environment
--------------------
-
-It is recommended to use a Python virtual environment to install and run `species` such that the correct versions of the dependencies can be installed without affecting other installed Python packages. First install `virtualenv`, for example with the |pip|:
-
-.. code-block:: console
-
-    $ pip install virtualenv
-
-Then create a virtual environment for Python 3:
-
-.. code-block:: console
-
-    $ virtualenv -p python3 folder_name
-
-And activate the environment with:
-
-.. code-block:: console
-
-    $ source folder_name/bin/activate
-
-A virtual environment can be deactivated with:
-
-.. code-block:: console
-
-    $ deactivate
-
-.. important::
-   Make sure to adjust the path where the virtual environment is installed and activated.
-
 Installation from PyPI
 ----------------------
 
 *species* can be installed from the |pypi| with the |pip|::
 
     $ pip install species
 
-If you do not use a virtual environment then you may have to add the ``--user`` argument:
-
-.. code-block:: console
-
-    $ pip install --user species
-
 To update the installation to the most recent version:
 
 .. code-block:: console
@@ -57,39 +21,24 @@ To update the installation to the most recent version:
 Installation from Github
 ------------------------
 
-Installation from Github is also possible by cloning the repository:
+Installation from Github is done by cloning the repository:
 
 .. code-block:: console
 
     $ git clone git@github.com:tomasstolker/species.git
 
-In that case, the dependencies can be installed from the `species` repository folder:
+And running the setup script to install the package and its dependencies:
 
 .. code-block:: console
 
-    $ pip install -r requirements.txt
+    $ python setup.py install
 
 Once a local copy of the repository exists, new commits can be pulled from Github with:
 
 .. code-block:: console
 
     $ git pull origin master
 
-And to update the dependencies for compatibility with `species`:
-
-.. code-block:: console
-
-    $ pip install --upgrade -r requirements.txt 
-
-By adding the path of the repository to the ``PYTHONPATH`` environment variable enables `species` to be imported from any location:
-
-.. code-block:: console
-
-    $ echo "export PYTHONPATH='$PYTHONPATH:/path/to/species'" >> folder_name/bin/activate
-
-.. important::
-   Make sure to adjust local path in which `species` will be cloned from the Github repository.
-
 Do you want to makes changes to the code? Then please fork the `species` repository on the Github page and clone your own fork instead of the main repository. Contributions and pull requests are very welcome (see :ref:`contributing` section).
 
 Testing `species`

diff --git a/setup.py b/setup.py
@@ -13,7 +13,7 @@
 setup(
     name='species',
     version='0.1.3',
-    description='Toolkit for spectral and photometric analysis of planetary and substellar atmospheres',
+    description='Toolkit for atmospheric characterization of exoplanets and brown dwarfs',
     long_description=open('README.rst').read(),
     long_description_content_type='text/x-rst',
     author='Tomas Stolker',

diff --git a/species/__init__.py b/species/__init__.py
@@ -52,7 +52,7 @@
                                    add_luminosity
 
 __author__ = 'Tomas Stolker'
-__license__ = 'GPLv3'
+__license__ = 'MIT'
 __version__ = '0.1.3'
 __maintainer__ = 'Tomas Stolker'
 __email__ = 'tomas.stolker@phys.ethz.ch'