Metadata-Version: 2.1
Name: pycollo
Version: 0.1.2
Summary: General-purpose nonlinear programming and optimal control using collocation methods
Home-page: https://pypi.org/project/pycollo/
Author: Sam Brockie
Author-email: sgb39@cam.ac.uk
License: MIT
Keywords: optimal control,optimal control problem,ocp,trajectory optimisation,trajectory optimization,collocation,direct collocation
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Topic :: Utilities
Requires-Python: >=3.7
Provides-Extra: docs
License-File: LICENSE

*******
Pycollo
*******

*Pycollo*, a combination of 'Python' and 'collocation', is a Python package for solving mutliphase optimal control problems using direct orthogonal collocation.

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.


Installation
============

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
=======

This project is licensed under the terms of the `MIT license <LICENSE>`_.

Authors
========

- Sam Brockie - sgb39@cam.ac.uk


