Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update small items on the website #362

Merged
merged 29 commits into from
Apr 20, 2024
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
addf3f6
add line to create bullet list for contributors
abachma2 Apr 1, 2024
270f655
add SAI, per @nuclearkatie rec in #337
abachma2 Apr 3, 2024
ec87ca8
add NNSA funder, per @nuclearkatie rec in #337
abachma2 Apr 3, 2024
3ca70d1
remove news in toc, per @nuclearkatie rec in #337
abachma2 Apr 3, 2024
80881b6
update numpy documentation link
abachma2 Apr 11, 2024
10556e4
update link to github3 documentation
abachma2 Apr 11, 2024
b42e263
remove toctree, add doc for Docker install
abachma2 Apr 11, 2024
cc419ac
add missing >, fix typo
abachma2 Apr 11, 2024
1da8834
change archetype install to pip
abachma2 Apr 11, 2024
bf130bf
move news to after Learn More, put quick start in toc tree
abachma2 Apr 11, 2024
1ca1de8
make edits requested by @bennibbelink
abachma2 Apr 15, 2024
80212f3
remove mention of Cyclist, per @gonuke
abachma2 Apr 15, 2024
72cf03b
formatting fixes from @bennibbelink review
abachma2 Apr 15, 2024
3fb0a8f
remove xo dependency
abachma2 Apr 18, 2024
02f7ed9
add line to create bullet list for contributors
abachma2 Apr 1, 2024
592f5fd
add SAI, per @nuclearkatie rec in #337
abachma2 Apr 3, 2024
d5a34e0
add NNSA funder, per @nuclearkatie rec in #337
abachma2 Apr 3, 2024
c73aec8
remove news in toc, per @nuclearkatie rec in #337
abachma2 Apr 3, 2024
b37f128
update numpy documentation link
abachma2 Apr 11, 2024
6d504dc
update link to github3 documentation
abachma2 Apr 11, 2024
12eb827
remove toctree, add doc for Docker install
abachma2 Apr 11, 2024
435d631
add missing >, fix typo
abachma2 Apr 11, 2024
906250d
change archetype install to pip
abachma2 Apr 11, 2024
ad7a49c
move news to after Learn More, put quick start in toc tree
abachma2 Apr 11, 2024
a5430aa
make edits requested by @bennibbelink
abachma2 Apr 15, 2024
ae8832a
remove mention of Cyclist, per @gonuke
abachma2 Apr 15, 2024
6cf9a6c
formatting fixes from @bennibbelink review
abachma2 Apr 15, 2024
3360941
remove xo dependency
abachma2 Apr 18, 2024
ddec1b5
Merge branch 'updates-1.6' of github.com:abachma2/cyclus.github.com i…
abachma2 Apr 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions source/arche/tutorial_py/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Now we can install the tutorial project via,
.. code-block:: console

~ $ cd tutorial
~/tutorial $ python setup.py install --user
~/tutorial $ python -m pip install .


Let's now make an example input file in a special ``input`` directory:
bennibbelink marked this conversation as resolved.
Show resolved Hide resolved
Expand All @@ -81,7 +81,7 @@ Let's now make an example input file in a special ``input`` directory:
~/tutorial $ mkdir -p input
~/tutorial $ touch input/storage.py

Now open up the ``input/storage.`` input file and edit it to look like:
Now open up the ``input/storage.py`` input file and edit it to look like:

.. code-block:: python

Expand Down
4 changes: 4 additions & 0 deletions source/basics/acknowledgements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ by a number of programs and agencies.

* Lab-grad program

* National Nuclear Security Administration

* NNIS Fellowship

The |Cyclus| project benefits greatly from the computational resources of the
University of Wisconsin-Madison's `Center for High Throughput Computing
<http://chtc.cs.wisc.edu>`_ and it's `BaTLab <http://www.batlab.org>`_ build
Expand Down
14 changes: 12 additions & 2 deletions source/basics/projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,17 @@ Consortium for Verification Technology
:width: 100

As part of the `Consortium for Verification Technology (CVT)
<http://cvt.engin.umich.edu/>`_, |Cyclus| is being used to study issues in
nuclear security and non-proliferation. Research areas include the
<http://cvt.engin.umich.edu/>`_, |Cyclus| was used to study issues in
nuclear security and non-proliferation. Research areas included the
incorporation of social-behavioral models to agent interactions, nuclear
material tracking and forensics, and detector sensitivity estimation.

Systems Analysis & Integration Campaign
---------------------------------------

As part of the `Systems Analysis & Integration Campaign (SA&I)
<https://fuelcycleoptions.inl.gov/SitePages/Home.aspx>`_, |Cyclus| is
used for modeling fuel cycles to understand potential future fuel
cycle needs and the economics of those fuel cycles.


4 changes: 2 additions & 2 deletions source/cep/cep6.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ CEP 6 - |Cyclus| Pull Request Style Guide

:CEP: 6
:Title: |Cyclus| Pull Request Style Guide
:Last-Modified: 2015-05-08
:Last-Modified: 2024-04-11
:Author: Matthew Gidden
:Status: Draft
:Type: Process
Expand Down Expand Up @@ -84,7 +84,7 @@ Automation

Using the Github `API <https://developer.github.com/v3/>`_ either directly or
through a module like `github3.py
<https://github3py.readthedocs.org/en/master/>`_ in conjunction with a standard
<https://github3.readthedocs.io/en/latest/>`_ in conjunction with a standard
style can allow for the automation of otherwise repetitive and time consuming
tasks. A chief use case is the generation of release notes. Specifically, if
every PR that enables a major and minor feature can be identified and
Expand Down
45 changes: 22 additions & 23 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,32 +30,10 @@ The |Cyclus| project repository is located at http://github.com/cyclus/cyclus

Quick Start
-----------
:doc:`Get started with Cyclus <user/install>`

News
----

**June 1st, 2018:** :doc:`Cyclus Newsletter Spring 2018! <newsletters/may2018>`

**October 6th, 2017:** :doc:`Cyclus Newsletter Fall 2017! <newsletters/oct2017>`

**December 13, 2016:** :doc:`Cyclus v1.5.0 is released <previous/v1.5>`

**July 6-8, 2016:** Technical workshop on Dynamic Fuel Cycle in Paris, France

**August 13, 2015:** :doc:`Cyclus included in FY2016 workscopes for the NEUP program <news/fy16neup>`

**July 21-24, 2015:** Joint workshop with CLASS_ project held in Madison, WI

**June 10, 2015:** First Cyclus :doc:`user tutorial <user/tutorial/index>` and :doc:`developer tutorial <arche/tutorial/index>` are held at the 2015 ANS Annual Meeting in San Antonio, TX

**June 7, 2015:** :doc:`Cyclus v1.3.1 is released <previous/v1.3>`

.. toctree::
:maxdepth: 1

news/fy16neup
newsletters/oct2017
user/install
bennibbelink marked this conversation as resolved.
Show resolved Hide resolved


Learn More
Expand All @@ -73,6 +51,26 @@ Learn More
previous/index
cite/index


News
----

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we generate some news? Maybe @abachma2's PhD?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nuclearkatie had an item about the latest news being from 2018, but I wasn't sure what news items we could add. We could add an announcement about the current NEUP grant, show that there is active development on the code.

**June 1st, 2018:** :doc:` <newsletters/may2018>`
bennibbelink marked this conversation as resolved.
Show resolved Hide resolved

**October 6th, 2017:** :doc:`Cyclus Newsletter Fall 2017! <newsletters/oct2017>`

**December 13, 2016:** :doc:`Cyclus v1.5.0 is released <previous/v1.5>`

**July 6-8, 2016:** Technical workshop on Dynamic Fuel Cycle in Paris, France

**August 13, 2015:** :doc:`Cyclus included in FY2016 workscopes for the NEUP program <news/fy16neup>`

**July 21-24, 2015:** Joint workshop with CLASS_ project held in Madison, WI

**June 10, 2015:** First Cyclus :doc:`user tutorial <user/tutorial/index>` and :doc:`developer tutorial <arche/tutorial_cpp/index>` are held at the 2015 ANS Annual Meeting in San Antonio, TX

**June 7, 2015:** :doc:`Cyclus v1.3.1 is released <previous/v1.3>`

.. _try-it:

Try It -- Out-of-Service
Expand All @@ -96,6 +94,7 @@ Contributors
------------

You can find our amazing contributors through their GitHub contributions for each of the projects:

* `Cyclus Contributors <https://github.com/cyclus/cyclus/graphs/contributors>`_

* `Cycamore Contributors <https://github.com/cyclus/cycamore/graphs/contributors>`_
Expand Down
2 changes: 1 addition & 1 deletion source/numpydoc/numpydoc.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
- Renumber references.
- Extract the signature from the docstring, if it can't be determined otherwise.

.. [1] https://github.com/numpy/numpy/blob/main/doc/HOWTO_DOCUMENT.rst.txt
.. [1] https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard

"""
from __future__ import division, absolute_import, print_function
Expand Down
16 changes: 6 additions & 10 deletions source/user/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,21 +40,17 @@ will identify the best approach for you.
- **Recommended** for developers or users who **require the bleeding edge version** of |Cyclus|
- **Required** for developers who wish to **contribute to kernel development** of |Cyclus|

* :doc:`Install from Docker <install_docker>`:

.. toctree::
:maxdepth: 1
- *Requires Docker install on machine and familiarity with Docker*

install_binary
install_docker
install_custom
install_from_git
install_from_tarball


2. Run Cyclus with a Sample XML File
1. Run Cyclus with a Sample XML File
bennibbelink marked this conversation as resolved.
Show resolved Hide resolved
-------------------------------------

Try running |Cyclus| for yourself. The result will be a :doc:`database <dbdoc>` named cyclus.sqlite. Use the drop down menu to load the sqlite file into Cyclist for data visualization, or use your favorite sqlite browser to peruse.
Try running |Cyclus| for yourself. The result will be a :doc:`database <dbdoc>` named cyclus.sqlite.
Use your favorite sqlite browser to peruse, or explore the data using
`Cymetric <https://github.com/cyclus/cymetric>`_.

.. code-block:: bash

Expand Down
6 changes: 3 additions & 3 deletions source/user/tutorial/add_sep.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The following is the input template for ``Cycamore::Separations`` archetype:
<item>
<comp>_______</comp>
<eff>_______</eff>
</item
</item>
</efficiencies>
</info>
</item>
Expand All @@ -47,7 +47,7 @@ The following is the input template for ``Cycamore::Separations`` archetype:
* Used-MOX-Fuel
* The maximum feed inventory is the most feed material that we'll have on
hand: 1000 tonnes.
* The maxium separations throughout is the size of our plant: 80 tonnes/timestep
* The maximum separations throughout is the size of our plant: 80 tonnes/timestep
* This simple scenario will have a single output stream: Separated-Fissile
* we will hold no more than 5 tonnes of separated material on hand at any time
* 99% of all Pu (94000) will go into that stream
Expand Down Expand Up @@ -82,7 +82,7 @@ Filling in the template, the input block looks like:
<item>
<comp>94000</comp>
<eff>0.99</eff>
</item
</item>
</efficiencies>
</info>
</item>
Expand Down