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.

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

Update moltres contact #250

Merged
merged 5 commits into from
Mar 1, 2022
Merged

Update moltres contact #250

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
664b994
Update links and remove Alex's contact
smpark7 Mar 1, 2022
34ba78f
Update contact
smpark7 Mar 1, 2022
b619f00
Add link to contributing guidelines
smpark7 Mar 1, 2022
b363cb2
Update software/moltres/moltres.md
smpark7 Mar 1, 2022
0ceabb0
Update software/moltres/moltres.md
smpark7 Mar 1, 2022
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
35 changes: 20 additions & 15 deletions software/moltres/moltres.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,30 @@ reactors.

## Use

Moltres documentation can be found at
http://arfc.github.io/software/moltres. Doxygen pages are
smpark7 marked this conversation as resolved.
Show resolved Hide resolved
[here](https://arfc.github.io/moltres/classes.html).
Outlines of the kernels and boundary
conditions used to construct the Moltres governing equations can be found on the
[Moltres wiki](./wiki/). Breakdown of a
full-fledged Moltres input file can be found
[here](./wiki/input_example/). New Moltres
users who have never used MOOSE before are encouraged to check-out its
[wiki](http://mooseframework.org/documentation.menu.html),
[tutorials](http://mooseframework.org/workshop/#/), and
[examples](http://mooseframework.org/examples/index.html) to help understand the
underlying Moltres components.
users who have never used MOOSE before are encouraged to check-out the MOOSE
workshop [slides](https://mooseframework.inl.gov/workshop/index.html#/) and
[video](https://www.youtube.com/watch?v=2tJwBsYaLaI)
to help understand the underlying Moltres components.

## Install

Moltres relies on the MOOSE framework. To install MOOSE please follow the
instructions at [this guide](http://mooseframework.org/getting_started/index.html). After installing
MOOSE, you can install Moltres by running the following commands in a shell
after changing into the directory holding your MOOSE directory (perhaps `~/projects`):
Moltres relies on the MOOSE framework. We suggest that users install the MOOSE
environment using Conda Packages by following the instructions in the `Install
MOOSE Conda Packages` section of
https://mooseframework.inl.gov/getting_started/installation/conda.html.
Since the Moltres repository contains MOOSE and Squirrel as Git
submodules, there is no need to clone MOOSE into a separate directory.
smpark7 marked this conversation as resolved.
Show resolved Hide resolved
Instead, users can install Moltres by running the following commands in a shell
after changing into the directory which will hold the Moltres directory
(perhaps `~/projects`):

```bash
git clone https://github.com/arfc/moltres
Expand All @@ -36,7 +43,8 @@ git submodule update
make -j8
```

You may also compile a debug version of Moltres by running `METHOD=dbg make
You may also compile a debug version of Moltres by replacing the last line with
`METHOD=dbg make
-j8`. Note that you should replace `8` with the number of processors available
on your machine.

Expand All @@ -47,8 +55,7 @@ root of the Moltres directory.

## Development

abachma2 marked this conversation as resolved.
Show resolved Hide resolved
API documentation for those interested in understanding or developing Moltres
can be found [here](https://arfc.github.io/moltres/). If you ever want to
If you ever want to
contribute changes to the Moltres repository, make sure you run
`scripts/install-format-hook.sh` before making any commits. This will ensure
that any commits you make adhere to the MOOSE/Moltres C++ style. Pull requests
Expand All @@ -58,8 +65,6 @@ the core Moltres physics capabilities.

## Contact

Contact Alex Lindsay at [email protected] for more information or
even better, please post to our discussion list at
[email protected].
Please post to our discussion list at [email protected].

![](phoenix_CC0.jpg)