From addf3f60477fbfd32fb59ddd41b6abddc77cea71 Mon Sep 17 00:00:00 2001 From: abachmann Date: Mon, 1 Apr 2024 14:20:56 -0500 Subject: [PATCH 01/28] add line to create bullet list for contributors --- source/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/index.rst b/source/index.rst index d4ac14d0..36b742b1 100644 --- a/source/index.rst +++ b/source/index.rst @@ -96,6 +96,7 @@ Contributors ------------ You can find our amazing contributors through their GitHub contributions for each of the projects: + * `Cyclus Contributors `_ * `Cycamore Contributors `_ From 270f655fe54458335addc52c145e7353a0d00f8d Mon Sep 17 00:00:00 2001 From: abachmann Date: Wed, 3 Apr 2024 17:27:35 -0500 Subject: [PATCH 02/28] add SAI, per @nuclearkatie rec in #337 --- source/basics/projects.rst | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/source/basics/projects.rst b/source/basics/projects.rst index 9741fd9a..c4964156 100644 --- a/source/basics/projects.rst +++ b/source/basics/projects.rst @@ -13,7 +13,17 @@ Consortium for Verification Technology :width: 100 As part of the `Consortium for Verification Technology (CVT) -`_, |Cyclus| is being used to study issues in -nuclear security and non-proliferation. Research areas include the +`_, |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) +`_, |Cyclus| is +used for modeling fuel cycles to understand potential future fuel +cycle needs and the economics of those fuel cycles. + + From ec87ca88056246af4b429dd30db2a649f8029574 Mon Sep 17 00:00:00 2001 From: abachmann Date: Wed, 3 Apr 2024 17:27:58 -0500 Subject: [PATCH 03/28] add NNSA funder, per @nuclearkatie rec in #337 --- source/basics/acknowledgements.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/basics/acknowledgements.rst b/source/basics/acknowledgements.rst index 9ce13338..448eec6a 100644 --- a/source/basics/acknowledgements.rst +++ b/source/basics/acknowledgements.rst @@ -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 `_ and it's `BaTLab `_ build From 3ca70d15820784df92749a8fdf2897538c3225ce Mon Sep 17 00:00:00 2001 From: abachmann Date: Wed, 3 Apr 2024 17:28:18 -0500 Subject: [PATCH 04/28] remove news in toc, per @nuclearkatie rec in #337 --- source/index.rst | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/source/index.rst b/source/index.rst index 36b742b1..6d9f8dfc 100644 --- a/source/index.rst +++ b/source/index.rst @@ -30,6 +30,7 @@ The |Cyclus| project repository is located at http://github.com/cyclus/cyclus Quick Start ----------- + :doc:`Get started with Cyclus ` News @@ -51,13 +52,6 @@ News **June 7, 2015:** :doc:`Cyclus v1.3.1 is released ` -.. toctree:: - :maxdepth: 1 - - news/fy16neup - newsletters/oct2017 - - Learn More ---------- From 80881b6c571823ae25f5e09e442a786d5041f454 Mon Sep 17 00:00:00 2001 From: abachmann Date: Thu, 11 Apr 2024 15:13:51 -0500 Subject: [PATCH 05/28] update numpy documentation link --- source/numpydoc/numpydoc.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/numpydoc/numpydoc.py b/source/numpydoc/numpydoc.py index 4c835548..2f9d5055 100644 --- a/source/numpydoc/numpydoc.py +++ b/source/numpydoc/numpydoc.py @@ -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 From 10556e4f3bbde66b295c5f8b50610d2e5189fc83 Mon Sep 17 00:00:00 2001 From: abachmann Date: Thu, 11 Apr 2024 15:15:05 -0500 Subject: [PATCH 06/28] update link to github3 documentation --- source/cep/cep6.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/cep/cep6.rst b/source/cep/cep6.rst index 5a17cdfe..ee7db660 100644 --- a/source/cep/cep6.rst +++ b/source/cep/cep6.rst @@ -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 @@ -84,7 +84,7 @@ Automation Using the Github `API `_ either directly or through a module like `github3.py -`_ in conjunction with a standard +`_ 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 From b42e263389e48a29e5b848a9ab18f19fb38a4eed Mon Sep 17 00:00:00 2001 From: abachmann Date: Thu, 11 Apr 2024 15:29:13 -0500 Subject: [PATCH 07/28] remove toctree, add doc for Docker install --- source/user/install.rst | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/source/user/install.rst b/source/user/install.rst index e76db4b8..fe17253f 100644 --- a/source/user/install.rst +++ b/source/user/install.rst @@ -40,21 +40,16 @@ 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 `: -.. 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 ------------------------------------- -Try running |Cyclus| for yourself. The result will be a :doc:`database ` 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 ` 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. .. code-block:: bash From cc419ace0e0acb364ac3d8bdcabf057663e038c9 Mon Sep 17 00:00:00 2001 From: abachmann Date: Thu, 11 Apr 2024 15:34:43 -0500 Subject: [PATCH 08/28] add missing >, fix typo --- source/user/tutorial/add_sep.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/user/tutorial/add_sep.rst b/source/user/tutorial/add_sep.rst index 927c6a3c..f21c494d 100644 --- a/source/user/tutorial/add_sep.rst +++ b/source/user/tutorial/add_sep.rst @@ -32,7 +32,7 @@ The following is the input template for ``Cycamore::Separations`` archetype: _______ _______ - @@ -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 @@ -82,7 +82,7 @@ Filling in the template, the input block looks like: 94000 0.99 - From 1da8834e2da9ebeeb68b3160ee139c66cfc3dd8a Mon Sep 17 00:00:00 2001 From: abachmann Date: Thu, 11 Apr 2024 15:35:50 -0500 Subject: [PATCH 09/28] change archetype install to pip --- source/arche/tutorial_py/setup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/arche/tutorial_py/setup.rst b/source/arche/tutorial_py/setup.rst index c175145a..16eca5d8 100644 --- a/source/arche/tutorial_py/setup.rst +++ b/source/arche/tutorial_py/setup.rst @@ -70,7 +70,7 @@ Now we can install the tutorial project via, .. code-block:: console ~ $ cd tutorial - ~/tutorial $ python setup.py install --user + ~/tutorial $ pip install . Let's now make an example input file in a special ``input`` directory: From bf130bf2292f8f1b041b9525cf476e1432e33f3a Mon Sep 17 00:00:00 2001 From: abachmann Date: Thu, 11 Apr 2024 16:02:54 -0500 Subject: [PATCH 10/28] move news to after Learn More, put quick start in toc tree --- source/index.rst | 40 ++++++++++++++++++++++------------------ 1 file changed, 22 insertions(+), 18 deletions(-) diff --git a/source/index.rst b/source/index.rst index 6d9f8dfc..1c31a1cd 100644 --- a/source/index.rst +++ b/source/index.rst @@ -31,12 +31,31 @@ The |Cyclus| project repository is located at http://github.com/cyclus/cyclus Quick Start ----------- -:doc:`Get started with Cyclus ` +.. toctree:: + :maxdepth: 1 + user/install + + +Learn More +---------- + +.. toctree:: + :maxdepth: 1 + + basics/index + user/index + arche/index + kernel/index + python/index + cep/cep0 + previous/index + cite/index + News ---- -**June 1st, 2018:** :doc:`Cyclus Newsletter Spring 2018! ` +**June 1st, 2018:** :doc:` ` **October 6th, 2017:** :doc:`Cyclus Newsletter Fall 2017! ` @@ -48,25 +67,10 @@ News **July 21-24, 2015:** Joint workshop with CLASS_ project held in Madison, WI -**June 10, 2015:** First Cyclus :doc:`user tutorial ` and :doc:`developer tutorial ` are held at the 2015 ANS Annual Meeting in San Antonio, TX +**June 10, 2015:** First Cyclus :doc:`user tutorial ` and :doc:`developer tutorial ` are held at the 2015 ANS Annual Meeting in San Antonio, TX **June 7, 2015:** :doc:`Cyclus v1.3.1 is released ` -Learn More ----------- - -.. toctree:: - :maxdepth: 1 - - basics/index - user/index - arche/index - kernel/index - python/index - cep/cep0 - previous/index - cite/index - .. _try-it: Try It -- Out-of-Service From 1ca1de807127c2267900c44c67d33d0052a74022 Mon Sep 17 00:00:00 2001 From: abachmann Date: Mon, 15 Apr 2024 09:03:15 -0500 Subject: [PATCH 11/28] make edits requested by @bennibbelink --- source/arche/tutorial_py/setup.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/arche/tutorial_py/setup.rst b/source/arche/tutorial_py/setup.rst index 16eca5d8..f79cb55b 100644 --- a/source/arche/tutorial_py/setup.rst +++ b/source/arche/tutorial_py/setup.rst @@ -70,7 +70,7 @@ Now we can install the tutorial project via, .. code-block:: console ~ $ cd tutorial - ~/tutorial $ pip install . + ~/tutorial $ python -m pip install . Let's now make an example input file in a special ``input`` directory: @@ -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 From 80212f3df4f5c70f75a4c38dea1895eea38bfff1 Mon Sep 17 00:00:00 2001 From: abachmann Date: Mon, 15 Apr 2024 09:03:41 -0500 Subject: [PATCH 12/28] remove mention of Cyclist, per @gonuke --- source/user/install.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/source/user/install.rst b/source/user/install.rst index fe17253f..9f6ee5cb 100644 --- a/source/user/install.rst +++ b/source/user/install.rst @@ -48,8 +48,9 @@ will identify the best approach for you. 1. Run Cyclus with a Sample XML File ------------------------------------- -Try running |Cyclus| for yourself. The result will be a :doc:`database ` 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 ` named cyclus.sqlite. +Use your favorite sqlite browser to peruse, or explore the data using +`Cymetric `_. .. code-block:: bash From 72cf03bbce143e2b39bf0953de0b1e60fdc07e54 Mon Sep 17 00:00:00 2001 From: abachmann Date: Mon, 15 Apr 2024 10:00:21 -0500 Subject: [PATCH 13/28] formatting fixes from @bennibbelink review --- source/index.rst | 3 ++- source/user/install.rst | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/source/index.rst b/source/index.rst index 1c31a1cd..4fdc4942 100644 --- a/source/index.rst +++ b/source/index.rst @@ -33,6 +33,7 @@ Quick Start .. toctree:: :maxdepth: 1 + user/install @@ -55,7 +56,7 @@ Learn More News ---- -**June 1st, 2018:** :doc:` ` +**June 1st, 2018:** :doc:`Cyclus Newsletter Spring 2018 ` **October 6th, 2017:** :doc:`Cyclus Newsletter Fall 2017! ` diff --git a/source/user/install.rst b/source/user/install.rst index 9f6ee5cb..36dcd673 100644 --- a/source/user/install.rst +++ b/source/user/install.rst @@ -45,7 +45,7 @@ will identify the best approach for you. - *Requires Docker install on machine and familiarity with Docker* -1. Run Cyclus with a Sample XML File +2. Run Cyclus with a Sample XML File ------------------------------------- Try running |Cyclus| for yourself. The result will be a :doc:`database ` named cyclus.sqlite. From 3fb0a8fc6d256bb3779c5b1fe3ba403ad7c4fbd7 Mon Sep 17 00:00:00 2001 From: Bachmann Date: Thu, 18 Apr 2024 09:16:16 -0500 Subject: [PATCH 14/28] remove xo dependency --- source/arche/tutorial_py/setup.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/source/arche/tutorial_py/setup.rst b/source/arche/tutorial_py/setup.rst index f79cb55b..c8c3234a 100644 --- a/source/arche/tutorial_py/setup.rst +++ b/source/arche/tutorial_py/setup.rst @@ -60,7 +60,6 @@ root tutorial directory. Create one that looks like: setup( name='tut', packages=['tut'], - scripts=['xo'], **setup_kwargs ) From 02f7ed992420e24a6072072383ac1575ef6ef850 Mon Sep 17 00:00:00 2001 From: abachmann Date: Mon, 1 Apr 2024 14:20:56 -0500 Subject: [PATCH 15/28] add line to create bullet list for contributors --- source/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/index.rst b/source/index.rst index d4ac14d0..36b742b1 100644 --- a/source/index.rst +++ b/source/index.rst @@ -96,6 +96,7 @@ Contributors ------------ You can find our amazing contributors through their GitHub contributions for each of the projects: + * `Cyclus Contributors `_ * `Cycamore Contributors `_ From 592f5fd025e2522d783484c385b011d9406f1d4c Mon Sep 17 00:00:00 2001 From: abachmann Date: Wed, 3 Apr 2024 17:27:35 -0500 Subject: [PATCH 16/28] add SAI, per @nuclearkatie rec in #337 --- source/basics/projects.rst | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/source/basics/projects.rst b/source/basics/projects.rst index 9741fd9a..c4964156 100644 --- a/source/basics/projects.rst +++ b/source/basics/projects.rst @@ -13,7 +13,17 @@ Consortium for Verification Technology :width: 100 As part of the `Consortium for Verification Technology (CVT) -`_, |Cyclus| is being used to study issues in -nuclear security and non-proliferation. Research areas include the +`_, |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) +`_, |Cyclus| is +used for modeling fuel cycles to understand potential future fuel +cycle needs and the economics of those fuel cycles. + + From d5a34e0d4863d658978a7a258719604280bbc88d Mon Sep 17 00:00:00 2001 From: abachmann Date: Wed, 3 Apr 2024 17:27:58 -0500 Subject: [PATCH 17/28] add NNSA funder, per @nuclearkatie rec in #337 --- source/basics/acknowledgements.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/basics/acknowledgements.rst b/source/basics/acknowledgements.rst index 9ce13338..448eec6a 100644 --- a/source/basics/acknowledgements.rst +++ b/source/basics/acknowledgements.rst @@ -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 `_ and it's `BaTLab `_ build From c73aec8cc2a7165f45ea941bf2be288c01e54359 Mon Sep 17 00:00:00 2001 From: abachmann Date: Wed, 3 Apr 2024 17:28:18 -0500 Subject: [PATCH 18/28] remove news in toc, per @nuclearkatie rec in #337 --- source/index.rst | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/source/index.rst b/source/index.rst index 36b742b1..6d9f8dfc 100644 --- a/source/index.rst +++ b/source/index.rst @@ -30,6 +30,7 @@ The |Cyclus| project repository is located at http://github.com/cyclus/cyclus Quick Start ----------- + :doc:`Get started with Cyclus ` News @@ -51,13 +52,6 @@ News **June 7, 2015:** :doc:`Cyclus v1.3.1 is released ` -.. toctree:: - :maxdepth: 1 - - news/fy16neup - newsletters/oct2017 - - Learn More ---------- From b37f1286e567898884fd493d43b51f9acfa015db Mon Sep 17 00:00:00 2001 From: abachmann Date: Thu, 11 Apr 2024 15:13:51 -0500 Subject: [PATCH 19/28] update numpy documentation link --- source/numpydoc/numpydoc.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/numpydoc/numpydoc.py b/source/numpydoc/numpydoc.py index 4c835548..2f9d5055 100644 --- a/source/numpydoc/numpydoc.py +++ b/source/numpydoc/numpydoc.py @@ -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 From 6d504dce6db2c66e48f7dff236ac14ea640387cf Mon Sep 17 00:00:00 2001 From: abachmann Date: Thu, 11 Apr 2024 15:15:05 -0500 Subject: [PATCH 20/28] update link to github3 documentation --- source/cep/cep6.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/cep/cep6.rst b/source/cep/cep6.rst index 5a17cdfe..ee7db660 100644 --- a/source/cep/cep6.rst +++ b/source/cep/cep6.rst @@ -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 @@ -84,7 +84,7 @@ Automation Using the Github `API `_ either directly or through a module like `github3.py -`_ in conjunction with a standard +`_ 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 From 12eb8270679c25278136dc3c3d9e063cdf3a37f7 Mon Sep 17 00:00:00 2001 From: abachmann Date: Thu, 11 Apr 2024 15:29:13 -0500 Subject: [PATCH 21/28] remove toctree, add doc for Docker install --- source/user/install.rst | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/source/user/install.rst b/source/user/install.rst index e76db4b8..fe17253f 100644 --- a/source/user/install.rst +++ b/source/user/install.rst @@ -40,21 +40,16 @@ 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 `: -.. 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 ------------------------------------- -Try running |Cyclus| for yourself. The result will be a :doc:`database ` 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 ` 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. .. code-block:: bash From 435d63175e4a7289ca75cdcd326311e33d4bef27 Mon Sep 17 00:00:00 2001 From: abachmann Date: Thu, 11 Apr 2024 15:34:43 -0500 Subject: [PATCH 22/28] add missing >, fix typo --- source/user/tutorial/add_sep.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/user/tutorial/add_sep.rst b/source/user/tutorial/add_sep.rst index 927c6a3c..f21c494d 100644 --- a/source/user/tutorial/add_sep.rst +++ b/source/user/tutorial/add_sep.rst @@ -32,7 +32,7 @@ The following is the input template for ``Cycamore::Separations`` archetype: _______ _______ - @@ -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 @@ -82,7 +82,7 @@ Filling in the template, the input block looks like: 94000 0.99 - From 906250d33cdb8fcb8f7472f2265563ff94d4ea48 Mon Sep 17 00:00:00 2001 From: abachmann Date: Thu, 11 Apr 2024 15:35:50 -0500 Subject: [PATCH 23/28] change archetype install to pip --- source/arche/tutorial_py/setup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/arche/tutorial_py/setup.rst b/source/arche/tutorial_py/setup.rst index c175145a..16eca5d8 100644 --- a/source/arche/tutorial_py/setup.rst +++ b/source/arche/tutorial_py/setup.rst @@ -70,7 +70,7 @@ Now we can install the tutorial project via, .. code-block:: console ~ $ cd tutorial - ~/tutorial $ python setup.py install --user + ~/tutorial $ pip install . Let's now make an example input file in a special ``input`` directory: From ad7a49c9045f12458aef0df50383c8bb41ec1e08 Mon Sep 17 00:00:00 2001 From: abachmann Date: Thu, 11 Apr 2024 16:02:54 -0500 Subject: [PATCH 24/28] move news to after Learn More, put quick start in toc tree --- source/index.rst | 40 ++++++++++++++++++++++------------------ 1 file changed, 22 insertions(+), 18 deletions(-) diff --git a/source/index.rst b/source/index.rst index 6d9f8dfc..1c31a1cd 100644 --- a/source/index.rst +++ b/source/index.rst @@ -31,12 +31,31 @@ The |Cyclus| project repository is located at http://github.com/cyclus/cyclus Quick Start ----------- -:doc:`Get started with Cyclus ` +.. toctree:: + :maxdepth: 1 + user/install + + +Learn More +---------- + +.. toctree:: + :maxdepth: 1 + + basics/index + user/index + arche/index + kernel/index + python/index + cep/cep0 + previous/index + cite/index + News ---- -**June 1st, 2018:** :doc:`Cyclus Newsletter Spring 2018! ` +**June 1st, 2018:** :doc:` ` **October 6th, 2017:** :doc:`Cyclus Newsletter Fall 2017! ` @@ -48,25 +67,10 @@ News **July 21-24, 2015:** Joint workshop with CLASS_ project held in Madison, WI -**June 10, 2015:** First Cyclus :doc:`user tutorial ` and :doc:`developer tutorial ` are held at the 2015 ANS Annual Meeting in San Antonio, TX +**June 10, 2015:** First Cyclus :doc:`user tutorial ` and :doc:`developer tutorial ` are held at the 2015 ANS Annual Meeting in San Antonio, TX **June 7, 2015:** :doc:`Cyclus v1.3.1 is released ` -Learn More ----------- - -.. toctree:: - :maxdepth: 1 - - basics/index - user/index - arche/index - kernel/index - python/index - cep/cep0 - previous/index - cite/index - .. _try-it: Try It -- Out-of-Service From a5430aaee33ed3055d387ecfa8c9b9ec390179c9 Mon Sep 17 00:00:00 2001 From: abachmann Date: Mon, 15 Apr 2024 09:03:15 -0500 Subject: [PATCH 25/28] make edits requested by @bennibbelink --- source/arche/tutorial_py/setup.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/arche/tutorial_py/setup.rst b/source/arche/tutorial_py/setup.rst index 16eca5d8..f79cb55b 100644 --- a/source/arche/tutorial_py/setup.rst +++ b/source/arche/tutorial_py/setup.rst @@ -70,7 +70,7 @@ Now we can install the tutorial project via, .. code-block:: console ~ $ cd tutorial - ~/tutorial $ pip install . + ~/tutorial $ python -m pip install . Let's now make an example input file in a special ``input`` directory: @@ -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 From ae8832a6d05f9accc0369f4384d69e6a7db91f35 Mon Sep 17 00:00:00 2001 From: abachmann Date: Mon, 15 Apr 2024 09:03:41 -0500 Subject: [PATCH 26/28] remove mention of Cyclist, per @gonuke --- source/user/install.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/source/user/install.rst b/source/user/install.rst index fe17253f..9f6ee5cb 100644 --- a/source/user/install.rst +++ b/source/user/install.rst @@ -48,8 +48,9 @@ will identify the best approach for you. 1. Run Cyclus with a Sample XML File ------------------------------------- -Try running |Cyclus| for yourself. The result will be a :doc:`database ` 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 ` named cyclus.sqlite. +Use your favorite sqlite browser to peruse, or explore the data using +`Cymetric `_. .. code-block:: bash From 6cf9a6c6f270966ff78b0fcbe1503d4e369f00b6 Mon Sep 17 00:00:00 2001 From: abachmann Date: Mon, 15 Apr 2024 10:00:21 -0500 Subject: [PATCH 27/28] formatting fixes from @bennibbelink review --- source/index.rst | 3 ++- source/user/install.rst | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/source/index.rst b/source/index.rst index 1c31a1cd..4fdc4942 100644 --- a/source/index.rst +++ b/source/index.rst @@ -33,6 +33,7 @@ Quick Start .. toctree:: :maxdepth: 1 + user/install @@ -55,7 +56,7 @@ Learn More News ---- -**June 1st, 2018:** :doc:` ` +**June 1st, 2018:** :doc:`Cyclus Newsletter Spring 2018 ` **October 6th, 2017:** :doc:`Cyclus Newsletter Fall 2017! ` diff --git a/source/user/install.rst b/source/user/install.rst index 9f6ee5cb..36dcd673 100644 --- a/source/user/install.rst +++ b/source/user/install.rst @@ -45,7 +45,7 @@ will identify the best approach for you. - *Requires Docker install on machine and familiarity with Docker* -1. Run Cyclus with a Sample XML File +2. Run Cyclus with a Sample XML File ------------------------------------- Try running |Cyclus| for yourself. The result will be a :doc:`database ` named cyclus.sqlite. From 3360941046d2bac6bc5b25853d93129c5a1df023 Mon Sep 17 00:00:00 2001 From: Bachmann Date: Thu, 18 Apr 2024 09:16:16 -0500 Subject: [PATCH 28/28] remove xo dependency --- source/arche/tutorial_py/setup.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/source/arche/tutorial_py/setup.rst b/source/arche/tutorial_py/setup.rst index f79cb55b..c8c3234a 100644 --- a/source/arche/tutorial_py/setup.rst +++ b/source/arche/tutorial_py/setup.rst @@ -60,7 +60,6 @@ root tutorial directory. Create one that looks like: setup( name='tut', packages=['tut'], - scripts=['xo'], **setup_kwargs )