Skip to content

Commit

Permalink
Merge pull request arfc#250 from smpark7/update-moltres-contact
Browse files Browse the repository at this point in the history
Update moltres contact
  • Loading branch information
abachma2 authored Mar 1, 2022
2 parents 93377de + 2718eea commit cb98da2
Showing 1 changed file with 23 additions and 15 deletions.
38 changes: 23 additions & 15 deletions software/moltres/moltres.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,30 @@ reactors.

## Use

Moltres documentation can be found
[here] (http://arfc.github.io/software/moltres). Doxygen pages are
[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.
The Moltres repository contains MOOSE and Squirrel as Git
submodules, therefore there is no need to clone MOOSE into a separate directory.
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,19 +55,19 @@ root of the Moltres directory.

## Development

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
should be submitted to the `devel` branch of the `arfc/moltres` repository. Each
pull request is automatically tested for style and for whether it breaks any of
the core Moltres physics capabilities.

A full list of contributing guidelines can be found
[here](https://github.com/arfc/moltres/blob/devel/CONTRIBUTING.md).

## 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)

0 comments on commit cb98da2

Please sign in to comment.