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

More general updates #367

Merged
merged 13 commits into from
May 8, 2024
6 changes: 3 additions & 3 deletions source/arche/dre.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ instance for each concrete ``Resource`` (i.e. ``Materials`` and ``Products``) of
the kernel is aware. For example, there is an exchange for ``Material``
resources and another for ``Product`` resources.

The DRE is comprised of five phases which execure in series:
The DRE is comprised of five phases which execute in series:

* :ref:`rfb`
* :ref:`rrfb`
Expand Down Expand Up @@ -110,10 +110,10 @@ be:
def get_material_requests(self):
request_qty = 10.0 # kg
# Material Target A
recipe_a = self.context().get_recipe("recipeA")
recipe_a = self.context.get_recipe("recipeA")
target_a = ts.Material.create_untracked(request_qty, recipe_a)
# Material Target B
recipe_b = self.context().get_recipe("recipeB")
recipe_b = self.context.get_recipe("recipeB")
target_b = ts.Material.create_untracked(request_qty, recipe_b)
# commodity mapping to request target
commods = {"FuelA": target_a, "FuelB": target_b}
Expand Down
2 changes: 1 addition & 1 deletion source/arche/tutorial_cpp/toolkit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ thus do not need a pragma

There needs to be a mechansim for keeping track of when materials enter the
inventory. In order to utilize Cyclus' sophisticated restart capability, we must
choose a data structure that is compatible with the at least one of the Cyclus
choose a data structure that is compatible with at least one of the Cyclus
output databases (see :ref:`dbtypes`). Given that requirement, an appropriate
data structure is a `list
<http://www.cplusplus.com/reference/list/list/>`_. Accordingly, add the
Expand Down
6 changes: 3 additions & 3 deletions source/arche/tutorial_py/state_var.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ Adding State Variables
=======================
In this lesson, we will:

1. Add the necessary state variables to define the storage facility
3. Modify the sample input file to include these variables
#. Add the necessary state variables to define the storage facility
#. Modify the sample input file to include these variables

Add State Variables
----------------------------------------------
The Cyclus Python interface preprocessor provides a ``typesystem`` module that help define
The Cyclus Python interface preprocessor provides a ``typesystem`` module that helps define
variables that are state variables for an archetype. These state vars also allow convenient
annotations.

Expand Down
2 changes: 1 addition & 1 deletion source/atemplates/sidebar.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h3>{{ _('Useful Pages') }}</h3>
</div>
<h3>Get Cyclus</h3>
<br>
Current version: <b>1.5.5</b>
Current version: <b>1.6.0</b>
<br><br>
Install:
<div class="highlight-bash" style="width:97.5%"><div class="highlight"><pre><span class="nv">$ </span>conda install cyclus cycamore</pre></div></div>
Expand Down
25 changes: 19 additions & 6 deletions source/cep/cep27.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Toolkit Implementation
======================

Each |Cyclus| toolkit component will contain 3 different files:

- 2 for the definition of the feature C++ class (``cpp`` and header) that allows
the use of the capabilities, and optionally to register its values in the
output database,
Expand Down Expand Up @@ -103,7 +104,9 @@ Example:
Without Inheritance:
--------------------
``toolkit/my_feature_snippet.cycpp.h``:
.. highlight:: c

.. code-block:: c

cyclus::toolkit::Position coordinates(0,0);

#pragma cyclus var { \
Expand All @@ -125,7 +128,9 @@ Without Inheritance:
std::vector<int> cycpp_shape_longitude;

``my_archetype_example.h``:
.. highlight:: c

.. code-block:: c

#include 'toolkit/Position.h'

class fun_archetype : public cyclus::facility{
Expand All @@ -137,7 +142,9 @@ Without Inheritance:
}

``my_archetype_example.cpp``:
.. highlight:: c

.. code-block:: c

void fun_archetype::EnterNotify() {
coordinates.set_position(latitude, longitude);
coordinates.RecordPosition(this);
Expand All @@ -147,7 +154,9 @@ Without Inheritance:
With Inheritance:
-----------------
``toolkit/my_feature_snippet.cycpp.h``:
.. highlight:: c

.. code-block:: c

#pragma cyclus var { \
"default": 0.0, \
"uilabel": "Geographical latitude in degrees as a double", \
Expand All @@ -167,7 +176,9 @@ With Inheritance:
std::vector<int> cycpp_shape_longitude;

``my_archetype_example.h``:
.. highlight:: c

.. code-block:: c

#include 'toolkit/Position.h'

class fun_archetype : public cyclus::facility, public Position {
Expand All @@ -179,7 +190,9 @@ With Inheritance:
}

``my_archetype_example.cpp``:
.. highlight:: c

.. code-block:: c

void fun_archetype::EnterNotify() {
this.set_position(latitude, longitude);
this.RecordPosition(this);
Expand Down
14 changes: 10 additions & 4 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,17 @@ Learn More
News
----

**June 1st, 2018:** :doc:`Cyclus Newsletter Spring 2018 <newsletters/may2018>`
**May 4, 2024:** `Cyclus v1.6.0 is released <https://github.com/cyclus/cyclus/releases/tag/1.6.0>`_

**October 6th, 2017:** :doc:`Cyclus Newsletter Fall 2017! <newsletters/oct2017>`
**April 29, 2024:** :doc:`FY 24 Funding for Cyclus <news/fy24neup>`

**December 13, 2016:** :doc:`Cyclus v1.5.0 is released <previous/v1.5>`
**January 14, 2020:** `Cyclus v1.5.5 is released <https://github.com/cyclus/cyclus/releases/tag/1.5.5>`_

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

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

**December 13, 2016:** `Cyclus v1.5.0 is released <https://github.com/cyclus/cyclus/releases/tag/1.5.0>`_

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

Expand All @@ -70,7 +76,7 @@ News

**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>`
**June 7, 2015:** `Cyclus v1.3.1 is released <https://github.com/cyclus/cyclus/releases/tag/1.3.0>`_

.. _try-it:

Expand Down
16 changes: 16 additions & 0 deletions source/news/fy24neup.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
FY2024 NEUP Funding for |Cyclus|
================================================

Date: April 29, 2024

For FY24-27 the NEUP_ program is providing $1 million in funding to
increase |Cyclus| capabilities to address current and emerging supply
chain and waste management challenges. The research team
is lead by:

* Dr. Madicken Munk (UIUC, PI)
* Prof. Paul P.H. Wilson, Ken Petersen (UW-Madison)
* Dr. Eva Davidon, Jin Whan Bae (ORNL)


.. _NEUP: http://www.neup.gov
19 changes: 4 additions & 15 deletions source/previous/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,10 @@
:align: center
:scale: 50

The following are release notes for and links to previously released versions of
|cyclus|:

.. toctree::
:maxdepth: 1

v1.5.5
v1.5
v1.3
v1.2
v1.1
v1.0
v0.4
v0.3
v0.2
Release notes and changelogs for previous versions of |Cyclus| are
available through the `project GitHub <https://github.com/cyclus/cyclus/releases>`_.
These pages also contain zips for the source code of each version. These zip
packages are also available below.
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need to maintain this table of zips/tarballs still?

Copy link
Member

Choose a reason for hiding this comment

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

While I agree that it would be great to avoid maintaining the table, it's nice to get a compact view of releases/release dates.... wonder if can automate that in a future update (i.e. make an issue)

Copy link
Member Author

Choose a reason for hiding this comment

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

All of the zips are on the github tags page. Maybe link to those?


Note: As official 1.4.0 release has been skipped, all the release notes of 1.4.0
have been included in the 1.5.0.
Expand Down
112 changes: 0 additions & 112 deletions source/previous/v0.2.rst

This file was deleted.

Loading