<commit_before>Rickshaw
===============

.. raw:: html

    <p style="text-align:center;">
    <span style="font-family:Times;font-size:28px;font-style:normal;font-weight:normal;text-decoration:none;text-transform:none;font-variant:small-caps;color:000000;">
    ~ A Stochastic Driver for Cyclus ~
    <br />
    <br />
    </span>
    </p>

Rickshaw is a Python-powered stochastic driver for Cyclus. Rickshaw will create randomly-generated,
fully-valid Cyclus input files. Rickshaw works by,

* Selecting a random fuel cycle structure by picking niches,
* Selecting random archetypes to represent those niches,
* Configure the archetypes by randomly selecting values for each state variable.

Rickshaw can run on the command line to generate JSON input files or operate in a server mode
that also runs Cyclus on the generated files. Rickshaw can interface with a variety of scheduluers,
including Docker (for a node) and Docker Swarm (for the full cluster).

=========
Contents
=========

.. toctree::
    :titlesonly:
    :maxdepth: 1

    api/index


.. .. include:: dependencies.rst


============
Contributing
============
We highly encourage contributions to rickshaw!  If you would like to contribute,
it is as easy as forking the repository on GitHub, making your changes, and
issuing a pull request.

==========
Contact Us
==========
If you have questions or comments, please contact the authors directly or
open an issue on GitHub.

=============
Helpful Links
=============

* `Documentation <http://xon.sh>`_
* `GitHub Repository <https://github.com/ergs/rickshaw>`_
* :ref:`genindex`<commit_msg>Added gettingstarted to ToC<commit_after>Rickshaw
===============

.. raw:: html

    <p style="text-align:center;">
    <span style="font-family:Times;font-size:28px;font-style:normal;font-weight:normal;text-decoration:none;text-transform:none;font-variant:small-caps;color:000000;">
    ~ A Stochastic Driver for Cyclus ~
    <br />
    <br />
    </span>
    </p>

Rickshaw is a Python-powered stochastic driver for Cyclus. Rickshaw will create randomly-generated,
fully-valid Cyclus input files. Rickshaw works by,

* Selecting a random fuel cycle structure by picking niches,
* Selecting random archetypes to represent those niches,
* Configure the archetypes by randomly selecting values for each state variable.

Rickshaw can run on the command line to generate JSON input files or operate in a server mode
that also runs Cyclus on the generated files. Rickshaw can interface with a variety of scheduluers,
including Docker (for a node) and Docker Swarm (for the full cluster).

=========
Contents
=========

.. toctree::
    :titlesonly:
    :maxdepth: 1

    api/index
    gettingstarted

.. .. include:: dependencies.rst


============
Contributing
============
We highly encourage contributions to rickshaw!  If you would like to contribute,
it is as easy as forking the repository on GitHub, making your changes, and
issuing a pull request.

==========
Contact Us
==========
If you have questions or comments, please contact the authors directly or
open an issue on GitHub.

=============
Helpful Links
=============

* `Documentation <http://xon.sh>`_
* `GitHub Repository <https://github.com/ergs/rickshaw>`_
* :ref:`genindex`
{'fraction_non_alphanumeric': 0.14100985221674878, 'fraction_numerical': 0.005541871921182266, 'mean_word_length': 4.46969696969697, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 19, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3340149', 'n_tokens_mistral': 973, 'n_tokens_neox': 889, 'n_words': 351}