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
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
2 changes: 2 additions & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ Learn More
News
----

**April 29,2024:** :doc:`FY 24 Funding for Cyclus <news/fy24neup>`

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

**October 6th, 2017:** :doc:`Cyclus Newsletter Fall 2017! <newsletters/oct2017>`
Expand Down
21 changes: 21 additions & 0 deletions source/news/fy24neup.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
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 (UW-Madison)
* Dr. Eva Davidon, Jin Whan Bae (ORNL)


.. _NEUP: http://www.neup.gov

.. _MARKAL: http://www.iea-etsap.org/web/Markal.asp
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
.. _MARKAL: http://www.iea-etsap.org/web/Markal.asp


.. _GCAM: http://www.globalchange.umd.edu/models/gcam/
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
.. _GCAM: http://www.globalchange.umd.edu/models/gcam/


57 changes: 57 additions & 0 deletions source/previous/v1.5.5.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
.. _1.5.5:

Copy link
Contributor

Choose a reason for hiding this comment

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

In our meeting on Monday we discussed modifying the "Cyclus Previous Versions" page to simply reference the GitHub releases. The releases already have the changes in the descriptions so it probably isn't necessary to copy/paste that information into the site as well. Do you have any thoughts about this?

Copy link
Member Author

Choose a reason for hiding this comment

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

So something like pointing to this page for the 1.5.5 release? Instead of having separate web pages for the releases?

Copy link
Contributor

@bennibbelink bennibbelink May 6, 2024

Choose a reason for hiding this comment

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

Not sure if we even need to link each release... we could say that all the releases can be found at this page so we don't need to manually copy/paste info from Github to the site with each release. I might have misunderstood the group consensus though - @gonuke what did you have in mind?

EDIT: Thats exactly what you did sorry :) I should've looked closer at your changes before commenting

==================================
Cyclus 1.5.5 Release
==================================
:Author: Cyclus Developers
:Website: http://fuelcycle.org/
:Contact: https://groups.google.com/forum/#!forum/cyclus-dev

The Cyclus core team is excited to announce the latest stable version of the
Cyclus ecosystem!

Major Features
==============

Compatibility:


`Cyclus <https://github.com/cyclus/cyclus>`_
---------------------------------------------

Features:



Bug fixes:




`Cycamore <https://github.com/cyclus/cycamore>`_
--------------------------------------------------


`Cymetric <https://github.com/cyclus/cymetric>`_
--------------------------------------------------


Summary
=======

Since v1.5.0,

* Cyclus: XXX commits resulting in YYY files changed, ZZZ insertions(+), AAA deletions(-)

* Cycamore: XXX commits resulting in YYY files changed, ZZZ insertions(+), AAA deletions(-)

* Cymetric: XXX commits resulting in YYY files changed, ZZZ insertions(+), AAA deletions(-)


Contributors
============
The following people contributed to this release of Cyclus. A "*" by their
name indicates a first time contributor. Names follow alphabetically,



4 changes: 2 additions & 2 deletions source/user/install_binary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Installing |Cyclus| with Binaries
At this point |Cyclus| should be successfully installed on your system and you are ready to install Cycamore.

#. Download the latest Cycamore Debian installation package `here
<https://github.com/cyclus/cycamore/releases/latest>`_. You can
download previous/different version `here <https://github.com/cyclus/cycamore/releases>`_.
<https://github.com/cyclus/cycamore/releases/latest>`_. Previous/different
versions are `also available <https://github.com/cyclus/cycamore/releases>`_.

#. Install the package by running:

Expand Down
Loading