This project is intended to provide an interface to a selection of MFEM based electromagnetics solvers. Hephaestus is still under active development and is being updated frequently.
- Fork this repository using the
fork
button on the front page - Remove the fork relationship:
Settings > General > Advanced > Remove fork relationship
- Rename your repository to align with your project:
Settings > General > Advanced > Rename repository
- Clone the repository with
git clone --recursive <your-project-url-here>.git
- Run
bash rename.sh <your-project-name>
- (Optionally open the project in VS Code)
- Start writing your software!
Hephaestus can be built with the following commands from the top level project directory:
mkdir build
cd build
cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Debug ..
make
make test
(Or equivalently, you can use cmake --build .
instead of make
, and ctest
instead of make test
.)