Merge pull request #34 from brocksam/release

Clean up repo for 0.1.0 release
brocksam · Jun 14, 2021 · 4fdc29a · 4fdc29a
2 parents 2d10cd6 + 1569a1c
commit 4fdc29a
Show file tree

Hide file tree

Showing 13 changed files with 32 additions and 439 deletions.
diff --git a/README.rst b/README.rst
@@ -4,22 +4,43 @@ Pycollo
 
 *Pycollo*, a combination of 'Python' and 'collocation', is a Python package for solving mutliphase optimal control problems using direct orthogonal collocation.
 
-Getting Started:
-================
+Getting Started
+===============
 
-This project is currently a work in progress and detailed instructions to get new users up and running are not yet available. Some working examples can be found in the [examples](examples) directory.
+This project is currently a work in progress and detailed instructions to get new users up and running are not yet available. Some working examples can be found in the `examples <examples>`_ directory.
 
-Contributing:
-=============
 
-Pycollo is currently under development and as such contributions are not accepted.
+Installation
+============
 
-Authors:
-========
+The easiest way to install pycollo is using the `Anaconda Python distribution <https://www.anaconda.com/what-is-anaconda/>`_ and its included *Conda* package management system. To install pycollo and its required dependencies, enter the following command at a command prompt:
+
+.. code-block:: bash
+
+    conda install pycollo
+
+To install using pip, enter the following command at a command prompt:
+
+.. code-block:: bash
+
+    pip install pycollo
+
+For more information, refer to the `installation documentation <https://pycollo.readthedocs.io/en/latest/user/installation.html>`_.
+
+Contribute
+==========
+
+Pycollo is currently under development. Major code refactors, including significant API changes, are likely. As such contributions may not be readily accepted at this time. If you are keen to contribute, please contact the authors by email or file an issue on the issue tracker detailing how you would like to get involved.
+
+- Issue Tracker: https://github.com/brocksam/pycollo/issues
+- Source Code: https://github.com/brocksam/pycollo
+
+License
+=======
 
-- **Sam Brockie** - ([email protected])
+This project is licensed under the terms of the `MIT license <LICENSE>`_.
 
-License:
+Authors
 ========
 
-This project is distributed under the MIT License [LICENSE](LICENSE).
+- Sam Brockie - [email protected]
diff --git a/...oblems/brachistochrone/brachistochrone.py → examples/brachistochrone/brachistochrone.py b/...oblems/brachistochrone/brachistochrone.py → examples/brachistochrone/brachistochrone.py
diff --git a/.../cart_pole_swing_up/cart_pole_swing_up.py → .../cart_pole_swing_up/cart_pole_swing_up.py b/.../cart_pole_swing_up/cart_pole_swing_up.py → .../cart_pole_swing_up/cart_pole_swing_up.py
diff --git a/...aunch_vehicle/delta_iii_launch_vehicle.py → ...aunch_vehicle/delta_iii_launch_vehicle.py b/...aunch_vehicle/delta_iii_launch_vehicle.py → ...aunch_vehicle/delta_iii_launch_vehicle.py
diff --git a/...ms/free_flying_robot/free_flying_robot.py → ...es/free_flying_robot/free_flying_robot.py b/...ms/free_flying_robot/free_flying_robot.py → ...es/free_flying_robot/free_flying_robot.py
diff --git a/...nsitive_problem/hypersensitive_problem.py → ...nsitive_problem/hypersensitive_problem.py b/...nsitive_problem/hypersensitive_problem.py → ...nsitive_problem/hypersensitive_problem.py
diff --git a/...ic_batch_reactor/kinetic_batch_reactor.py → ...ic_batch_reactor/kinetic_batch_reactor.py b/...ic_batch_reactor/kinetic_batch_reactor.py → ...ic_batch_reactor/kinetic_batch_reactor.py
diff --git a/..._reentry_trajectory_maximum_crossrange.py → ..._reentry_trajectory_maximum_crossrange.py b/..._reentry_trajectory_maximum_crossrange.py → ..._reentry_trajectory_maximum_crossrange.py
diff --git a/...control/space_station_attitude_control.py → ...control/space_station_attitude_control.py b/...control/space_station_attitude_control.py → ...control/space_station_attitude_control.py
diff --git a/examples/superseded/multiphase_complex_example.py b/examples/superseded/multiphase_complex_example.py