Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .coverage
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Coverage requirement configuration for swift, enforced in CIVET testing
# Coverage requirement configuration for Marlin, enforced in CIVET testing
#
# Valid configuration options:
# - require_new: Requires this percentage of coverage for new lines added
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -331,4 +331,4 @@ share/
/modules/misc/misc.yaml
/tutorials/tutorial01_app_development/*/babbler.yaml
/tutorials/darcy_thermo_mech/*/darcy_thermo_mech.yaml
swift.yaml
marlin.yaml
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ include $(MOOSE_DIR)/modules/modules.mk

# dep apps
APPLICATION_DIR := $(CURDIR)
APPLICATION_NAME := swift
APPLICATION_NAME := marlin
BUILD_EXEC := yes
GEN_REVISION := no
include $(FRAMEWORK_DIR)/app.mk
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
<img src="https://github.com/idaholab/marlin/blob/rename_swift_to_marlin/doc/content/marlin.png?raw=true" width="80%" alt="Marlin Logo">
<img src="https://github.com/idaholab/marlin/blob/main/doc/content/marlin.png?raw=true" width="80%" alt="Marlin Logo">

**Marlin** is a device independent Fourier spectral solver application based on the [MOOSE Finite Element Framework](http://mooseframework.org). Marlin supports[^1] CPU, CUDA, and MPS[^2] with automatic detection of supported device precision. <!-- [<img align="right" src="https://civet.inl.gov/idaholab/swift/main/branch_status.svg/">](https://civet.inl.gov/repo/idaholab/swift/) -->
**Marlin** is a device independent Fourier spectral solver application based on the [MOOSE Finite Element Framework](http://mooseframework.org). Marlin supports[^1] CPU, CUDA, and MPS[^2] with automatic detection of supported device precision.
[<img align="right" src="https://civet.inl.gov/idaholab/marlin/main/branch_status.svg/">](https://civet.inl.gov/repo/idaholab/marlin/)

[^1]: more compute device types might be supported, but have not been tested.
[^2]: torch MPS supports only single precision calculations!

> Note: Marlin was previously named Swift <img src="https://github.com/idaholab/swift/blob/main/doc/content/swift.png?raw=true" height="20pt">
> Note: Marlin was previously named Swift <img src="https://github.com/idaholab/marlin/blob/main/doc/content/swift.png?raw=true" height="20pt">

## Contacts

Expand Down
10 changes: 5 additions & 5 deletions doc/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Content:
swift:
marlin:
root_dir: ${ROOT_DIR}/doc/content
moose:
root_dir: ${MOOSE_DIR}/framework/doc/content
Expand All @@ -12,12 +12,12 @@ Renderer:
type: MooseDocs.base.MaterializeRenderer
Extensions:
MooseDocs.extensions.navigation:
name: swift
repo: https://github.com/idaholab/swift
name: marlin
repo: https://github.com/idaholab/marlin
menu:
Getting Started:
Installing Swift: installation.md
Help Forum: https://github.com/idaholab/swift/discussions
Installing Marlin: installation.md
Help Forum: https://github.com/idaholab/marlin/discussions
Documentation:
Syntax Index: syntax/index.md
Source Index: source/index.md
Expand Down
2 changes: 1 addition & 1 deletion doc/content/citing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# How to cite Swift
# How to cite Marlin

SoftwareX publication is in preparation. Check back soon!
6 changes: 2 additions & 4 deletions doc/content/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
!config navigation breadcrumbs=False scrollspy=False

!media swift.svg style=display:block;margin-left:auto;margin-right:auto;margin-top:1em;width:30%;
!media marlin.svg style=display:block;margin-left:auto;margin-right:auto;margin-top:1em;width:30%;

# Swift class=center style=font-weight:500;font-size:350%;margin-top:0

# a Fourier spectral solver application based on the [MOOSE Finite Element Framework](http://mooseframework.org) class=center style=font-weight:300;font-size:150%
# based on the [MOOSE Finite Element Framework](http://mooseframework.org) class=center style=font-weight:300;font-size:150%

!row!
!col! small=12 medium=4 large=4 icon=computer
Expand Down
10 changes: 5 additions & 5 deletions doc/content/installation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Installing Swift
# Installing Marlin

## Linux and INL HPC

Expand All @@ -9,7 +9,7 @@ Use the `moose-dev-openmpi-cudatorch-x86_64` [apptainer](https://mooseframework.
**Conda:** create a separate conda environment for PyTorch (and do not activate it)

```
conda create -n pytorch_swift pytorch
conda create -n pytorch_marlin pytorch
```

Check out and update the MOOSE submodule
Expand All @@ -22,18 +22,18 @@ Use the MOOSE configure script to enable libtorch and point it to the pytorch co

```
cd moose
export LIBTORCH_DIR=$(conda activate pytorch_swift; echo $CONDA_PREFIX; conda deactivate)
export LIBTORCH_DIR=$(conda activate pytorch_marlin; echo $CONDA_PREFIX; conda deactivate)
./configure --with-libtorch
```

Step back into the swift root directory and build.
Step back into the marlin root directory and build.

```
cd ..
make -j
```

Swift on arm64 macs installed this way will support `cpu` and `mps` as compute devices. An mps/cpu (12 threads) runtime comparison for an M2 max laptop is shown below. Note that MPS only supports single precision (32bit) floating point numbers.
Marlin on arm64 macs installed this way will support `cpu` and `mps` as compute devices. An mps/cpu (12 threads) runtime comparison for an M2 max laptop is shown below. Note that MPS only supports single precision (32bit) floating point numbers.

| Example | `cpu` runtime | `mps` runtime |
| - | - | - |
Expand Down
Binary file modified doc/content/marlin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 28 additions & 15 deletions doc/content/marlin.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading