Update readme and installation guidelines

Author: loganbvh

CONTRIBUTING.md

@@ -58,3 +58,30 @@ Ready to contribute? Follow [GitHub best practices](https://www.asmeurer.com/git
 6. Make your changes and commit them (testing locally).
 7. Push changes to the topic branch on *your* remote once local tests pass and you are happy with the changes you've made.
 8. Create a pull request against the base `main` branch through the Github website.
+
+## Making the Docs
+
+Make an HTML version of the documentation.
+
+> **Note**: This might require installing [Pandoc](https://pandoc.org/installing.html).
+
+```
+pip install sphinx sphinx_rtd_theme nbsphinx
+cd docs
+make html
+```
+
+## Unit Tests
+
+Run all of the unit tests from a Python session using
+
+``` python
+>>> import sequencing.testing as st
+>>> st.run()
+```
+
+Or run them from the command line, using
+
+```
+pytest --cov
+```

README.md

@@ -6,61 +6,19 @@
 composed of many modes and generating complex time-dependent control Hamiltonians
 for [master equation simulations](http://qutip.org/docs/latest/guide/dynamics/dynamics-master.html).
 
-### Requirements:
+## Documentation
 
-- `python>=3.7` (``sequencing`` is tested on 3.7, 3.8, and 3.9)
-- [`qutip>=4.5`](http://qutip.org/docs/latest/installation.html)
-- [`attrs>=20`](https://www.attrs.org/en/stable/index.html)
-- [`tqdm`](https://tqdm.github.io/)
-- [`lmfit`](https://lmfit.github.io/lmfit-py/)
+The documentation for `sequencing` is available at:
+[https://sequencing.readthedocs.io/](https://sequencing.readthedocs.io/)
 
-### Installing from source:
-
-- Clone the `sequencing` repo
-- Create a conda environment
-  - `conda create -n <env-name> python=<3.7, 3.8, or 3.9>`
-- Activate the conda environment
-  - `conda activate <env-name>`
-- Install `sequencing`
-  - `pip install -e .`, or 
-  - `python setup.py develop` (or `install`)
-
-
-**Important note for Windows users:**
-
->[QuTip: Installation on MS Windows:](http://qutip.org/docs/latest/installation.html#installation-on-ms-windows) As of QuTiP 4.1, recommended installation on Windows requires Python 3.5+, as well as Visual Studio 2015... When installing Visual Studio 2015 be sure to select options for the C++ compiler... The ‘Community’ edition of Visual Studio 2015 is free...
-
-### Getting started:
-
-Check out the tutorial notebooks [here](docs/source/notebooks)
-
-### Unit tests:
-
-Run all of the unit tests from a Python session using
-
-``` python
->>> import sequencing.testing as st
->>> st.run()
-```
-
-Or run them from the command line, using
+## Installation
 
 ```
-pytest --cov
+pip install sequencing
 ```
 
-### Contributing:
-Want to contribute to `sequencing`? Check out our [contribution guidelines](CONTRIBUTING.md).
-
-
-### Making the docs:
+For more details, see the [documentation](https://sequencing.readthedocs.io/en/latest/installation.html).
 
-Make an HTML version of the documentation.
+## Contributing:
 
-> **Note**: This might require installing [Pandoc](https://pandoc.org/installing.html).
-
-```
-pip install sphinx sphinx_rtd_theme nbsphinx
-cd docs
-make html
-```
+Want to contribute to `sequencing`? Check out our [contribution guidelines](CONTRIBUTING.md).

docs/source/installation.rst

@@ -9,7 +9,7 @@ Installation
 
 This section of the documentation describes the recommended method for installing and verifying ``sequencing``.
 
-We strongly recommend creating a new
+We recommend creating a new
 `conda environment <https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html>`_
 for ``sequencing``. Here we call the environment ``sequencing-env``, but you may
 call it whatever you like. ``sequencing`` is compatible with Python 3.7, 3.8, and 3.9.
@@ -26,18 +26,18 @@ call it whatever you like. ``sequencing`` is compatible with Python 3.7, 3.8, an
       `QuTip: Installation on MS Windows <http://qutip.org/docs/latest/installation.html#installation-on-ms-windows>`_: 
       The only supported installation configuration is using the Conda environment with Python 3.5+ and Visual Studio 2015.
 
-.. Installing with pip
-.. ===================
+Installing with pip
+===================
 
-.. .. code-block:: bash
+.. code-block:: bash
 
-..     (sequencing-env) pip install sequencing
+    (sequencing-env) pip install sequencing
 
 
 Installing from source
 ======================
 
-You can install ``sequencing`` from
+Alternatively, you can install ``sequencing`` from
 `GitHub <https://github.com/sequencing-dev/sequencing>`_ using the following commands:
 
 .. code-block:: bash

setup.py

@@ -7,7 +7,6 @@
 for [master equation simulations](http://qutip.org/docs/latest/guide/dynamics/dynamics-master.html).
 """
 
-import os
 from setuptools import setup, find_packages
 
 DESCRIPTION = "seQuencing: simulate realistic quantum control sequences using QuTiP"