Skip to content

Update documentation #22

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.

Sign up for GitHub

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

Open
abachma2 wants to merge 7 commits into
base: master
Choose a base branch
from
+134 −125
Open

Update documentation #22

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7a9c751
update README to Recycle from Cycamore
abachma2 Jul 15, 2025
bf20057
change instanses of cycamore to recycle
abachma2 Jul 16, 2025
f50e55f
Update CONTRIBUTING.rst with @gonuke
abachma2 Jul 16, 2025
507243b
change recycle_dir to recycle and talk about cloning
abachma2 Jul 17, 2025
45467e5
remove directory name from commands
abachma2 Jul 25, 2025
edd554a
copy from cyclus repo
abachma2 Aug 8, 2025
2ff1c92
change cyclus from recycle
abachma2 Aug 8, 2025
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
28 changes: 14 additions & 14 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ You can run the tests yourself using:

$ cyclus_unit_tests

- for Cycamore:
- for Recycle:

.. code-block:: bash

Expand Down Expand Up @@ -95,21 +95,21 @@ three branches: "Master", "Develop", and "Work".
Acquiring Cyclus and Workflow
-----------------------------

We begin with a fork of the main ("blessed") Cyclus repository. After initially forking
We begin with a fork of the main ("blessed") Recycle repository. After initially forking
the repo, we will have two branches in our fork: "Master" and "Develop".

Acquiring a Fork of the Cyclus Repository
Acquiring a Fork of the Recycle Repository
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A fork is *your* copy of Cyclus. Github offers an excellent
A fork is *your* copy of Recycle. Github offers an excellent
`tutorial <http://help.github.com/fork-a-repo/>`_ on how to set one up. The rest of this
example assumes you have set up the "upstream" repository as ``cyclus/core``. Note that git
example assumes you have set up the "upstream" repository as ``recycle/core``. Note that git
Comment thread
abachma2 marked this conversation as resolved.
Outdated
refers to your fork as "origin".

First, let's make our "work" branch:
::
.../cyclus_dir/$ git branch work
.../cyclus_dir/$ git push origin work
.../recycle_dir/$ git branch work

@gonuke gonuke Jul 16, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

(here & elsewhere) unless we instruct the user specifically, this is not the name of the directory that git will create

@abachma2 abachma2 Jul 16, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

You're talking about the recycle_dir part of this text? Or the branch names? I think this was pulled from Cycamore so the document there probably has this text too.

@gonuke gonuke Jul 16, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

recycle_dir - we probably wrote the documentation this way to be clear that it was a directory, but a standard git clone will not create a directory with this name.

We can either give more specific guidance on the git command, or refer to more standard directory names.

I expect this is also flawed on the Cycamore CONTRIBUTING doc

@abachma2 abachma2 Jul 17, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Just added something in to talk about this. 99% chance this language is also in the Cyclus docs, and 100% chance this is in the Cycamore docs.

@gonuke gonuke Jul 19, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'll also note that while I was updated fuelcycle.org @dean-krueger noted that he found the inclusion of the directory in the prompt confusing and worried that some might cut/paste the line that included the directory name. I then discovered that Sphinx will do syntax-based formatting, but only if we do NOT include the directory name. So maybe we take out the directory name entirely?

@abachma2 abachma2 Jul 25, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Updated this file to remove the directory name. How would we use the Sphinx syntax-based formatting for this directory? Or is that something the other repos will use and we should just be consistent across the orgs?

.../recycle_dir/$ git push origin work

We now have the following situation: there exists the "blessed" copy of the Master and
Develop branches, there exists your fork's copy of the Master, Develop, and Work branches,
Expand All @@ -128,14 +128,14 @@ work, finished, and successfully pushed your changes to your *Origin*
repository. You are now at home and want to continue working a bit. To begin,
let's update our *home's local branches*. ::

.../cyclus_dir/$ git checkout master
.../cyclus_dir/$ git pull upstream master
.../cyclus_dir/$ git push origin master
.../recycle_dir/$ git checkout master
.../recycle_dir/$ git pull upstream master
.../recycle_dir/$ git push origin master

.../cyclus_dir/$ git checkout work
.../cyclus_dir/$ git pull origin work
.../cyclus_dir/$ git rebase master
.../cyclus_dir/$ git push origin work
.../recycle_dir/$ git checkout work
.../recycle_dir/$ git pull origin work
.../recycle_dir/$ git rebase master
.../recycle_dir/$ git push origin work

Perhaps a little explanation is required. We first want to make sure that this new local copy of
the master branch is up-to-date with respect to the remote origin's branch and remote upstream's
Expand Down
10 changes: 5 additions & 5 deletions DEPENDENCIES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
##############################################
Installing Cycamore Dependencies from Binaries
Installing Recycle Dependencies from Binaries
##############################################

To see user and developer documentation for this code, please visit
the `Cyclus Homepage`_.

This method describes two methods for installing Cycamore's only dependency,
This method describes two methods for installing Recycle's only dependency,
the Cyclus Core, from binary distributions. If you would like to install it
from source code, please see the `Cyclus Core repository
<http://github.com/cyclus/cyclus>`_.
Expand All @@ -20,7 +20,7 @@ Dependencies
==================== ==================
Package Minimum Version
==================== ==================
`Cyclus` 1.4
`Cyclus` 1.6
==================== ==================


Expand All @@ -38,13 +38,13 @@ The Cyclus Core supports two binary installation options:

**Conda** is a cross-platform, user-space package manager aimed at simplifying
the installation of open source software. The Cyclus project uses Conda to
distribute pre-built Cyclus and Cycamore binaries.
distribute pre-built Cyclus binaries.

The **Debian package manager** simplifies the installation of open-source
software. It contains all of the files required to use specific software, as
well as variety of relevant information: maintainer, description, version,
dependencies (other software or libraries required to use it). The Cyclus
team provides pre-built Cyclus and Cycamore Debian packages to simplify
team provides pre-built Cyclus Debian package to simplify
installation for the user. These packages are available for LTS Ubuntu version
14.04 and 16.04 (though they may also work on other Linux systems).

Expand Down
2 changes: 1 addition & 1 deletion INSTALL.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Recycle's only dependency is the Cyclus Core.
==================== ==================
Package Minimum Version
==================== ==================
`Cyclus` 1.4
`Cyclus` 1.6
==================== ==================

There are a number of ways to install the Cyclus core:
Expand Down
49 changes: 21 additions & 28 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,21 @@
###################################################
Cycamore : The CYClus Additional MOdules REpository
Recycle
###################################################

Additional modules for the Cyclus nuclear fuel cycle simulator from the
Additional archetypes for the Cyclus nuclear fuel cycle simulator from the
University of Wisconsin - Madison are intended to support innovative

@dean-krueger dean-krueger Aug 9, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Are these archetypes from UW-Madison? Maybe I'm misreading this, but I thought all the Recycle stuff was from UIUC/Argonne at the moment?

@abachma2 abachma2 Aug 11, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Honestly, I'm not sure. It might just be carryover from Cycamore and I didn't catch it. Probably best to just remove an organization.

fuel cycle simulations with the Cyclus fuel cycle simulator.
fuel cycle simulations with Cyclus. The archetypes in this library are
more advanced than those present in the `Cycamore Library <https://github.com/cyclus/cycamore>`_.

This README is intended primarily for those who intend to contribute to the
development of Cycamore archetypes. If you are interested in Cyclus as a user
or in developing your own Cyclus archetyes, you may want to consult `Getting
development of Recycle archetypes. If you are interested in Cyclus as a user
or in developing your own Cyclus archetypes, you may want to consult `Getting
Started with Cyclus <http://fuelcycle.org/user/install.html>`_.

This README provides basic information about:
- the dependency required by Cycamore
- installation of Cycamore from the command line
- how to run Cycamore unit tests

Although Cycamore is meant to enable a basic fuel cycle simulation, you may want
more functionality than it offers. Third party modules can also be installed
(or developed) with additional facilities. Please visit the Cyclus website for
a list of `contributed modules <http://fuelcycle.org/user/index.html#third-party-archetypes>`_.
- the dependency required by Recycle
- installation of Recycle from the command line
- how to run Recycle unit tests

- **For general information about Cyclus, visit the** `Cyclus Homepage`_,

Expand All @@ -29,7 +25,7 @@ a list of `contributed modules <http://fuelcycle.org/user/index.html#third-party
- **To see user and developer documentation for this code, please visit
the** `Users Guide <http://fuelcycle.org/user/index.html>`_,

- **If you would like to contribute to Cycamore, please check our**
- **If you would like to contribute to Recycle, please check our**
`Contribution Guidelines <https://github.com/cyclus/cyclus/blob/master/CONTRIBUTING.rst>`_.


Expand All @@ -40,12 +36,12 @@ a list of `contributed modules <http://fuelcycle.org/user/index.html#third-party
Dependencies
************

Cycamore's only dependency is the Cyclus Core.
Recycle's only dependency is the Cyclus Core.

==================== ==================
Package Minimum Version
==================== ==================
`Cyclus` 1.4
`Cyclus` 1.6
==================== ==================

There are a number of ways to install the Cyclus core:
Expand All @@ -57,19 +53,16 @@ There are a number of ways to install the Cyclus core:
`Installing Cyclus from Binaries <DEPENDENCIES.rst>`_

******************************
Quick Cycamore Installation
Quick Recycle Installation
******************************

Assuming you have the dependencies installed correctly, installing Cyclus using
Assuming you have the dependencies installed correctly, installing Recycle using
github is fairly straightforward:

- Clone the Cyclus Repo: ``git clone https://github.com/cyclus/recyle.git``,

- to install Cyclus locally (in ``~/.local/``) just run: ``python install.py``
from recyle folder,
- clone the Recycle Repo: ``git clone https://github.com/cyclus/recyle.git``,

- finally, add the following Cyclus installation path (``~/.local/cyclus``) to
the **bottom** on your ``$PATH``.
- to install Recycle locally (in ``~/.local/``) just run: ``python install.py``
from recycle folder,

For more detailed installation procedure, and/or custom installation please
refer to the `INSTALLATION guide <INSTALL.rst>`_.
Expand All @@ -79,7 +72,7 @@ refer to the `INSTALLATION guide <INSTALL.rst>`_.
Running Tests
******************************

Installing Cycamore will also install a test driver (i.e., an executable of all of
Installing Recycle will also install a test driver (i.e., an executable of all of
our tests). You can run the tests yourself via:

.. code-block:: bash
Expand All @@ -93,13 +86,13 @@ Contributing
We happily welcome new developers into the Cyclus Developer Team. If you are willing
to contribute into Cyclus, please follow this procedure:

#. Fork Cycamore repository,
#. Fork Recycle repository,

#. Create a working branch on you fork from the ``master`` branch,

@dean-krueger dean-krueger Aug 9, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

master --> main?

@dean-krueger dean-krueger Aug 9, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Maybe recycle uses master still, but I thought I saw a bunch of other places where this change was made.

@abachma2 abachma2 Aug 11, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Recycle does still use master. I want to make that change on this repo, probably once these changes are merged. So let's make sure they all say main.


#. Implement your modification of the Cycamore source code,
#. Implement your modification of the Recycle source code,

#. Submit a Pull request into ``recyle/master`` branch,
#. Submit a Pull request into ``recycle/master`` branch,

@dean-krueger dean-krueger Aug 9, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

master --> main again?

@abachma2 abachma2 Aug 11, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

See above comment.


#. Wait for reviews/merge (the Puller cannot be the Merger).

Expand Down