Skip to content

Commit

Permalink
Update license, readme and docs generation
Browse files Browse the repository at this point in the history
  • Loading branch information
Steriva committed Jul 24, 2024
1 parent 61531b1 commit ce15437
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 7 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 ERMETE-Lab
Copyright (c) 2022 Stefano Riva

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# MP-OFELIA
**Openmc-FEnicsx for muLtiphysics tutorIAl**
# MultiPhysics in Python - OFELIA

**Authors:** Lorenzo Loi, Stefano Riva, Carolina Introini, Antonio Cammi
**OFELIA: Openmc-FEnicsx for muLtiphysics tutorIAl**
**Authors**: Lorenzo Loi, Stefano Riva, Carolina Introini, Antonio Cammi

This repository collects the supporting code for OFELIA (Openmc-FEnicsx for muLtiphysics tutorIAl): an open-source tool to simulate multi-physics nuclear cases adopting [OpenMC (v 0.13.2)](https://openmc.org/) and [FEniCSx (v. 0.6.0)](https://fenicsproject.org/) for Python.
This repository collects the supporting code for OFELIA (Openmc-FEnicsx for muLtiphysics tutorIAl): an open-source tool to simulate multi-physics nuclear cases adopting [OpenMC (v 0.13.2)](https://openmc.org/) and [FEniCSx (v. 0.6.0)](https://fenicsproject.org/) for Python. Moreover, useful tutorials are available for the single-physics codes OpenMC and FEniCSx.

--------------------------------
**In the coming months, the code files supporting the findings will be published here once the peer-review process of the related journal article will be completed.**
Expand All @@ -12,9 +12,21 @@ This repository collects the supporting code for OFELIA (Openmc-FEnicsx for muLt

## How to cite
If you use this code in your research, please cite the following paper
```latex
@article{

- Loi, L., Riva, S., Introini, C., Giacobbo, F., Wang, X., & Cammi, A. (2024). OFELIA: an OpenMC-FEniCSx Coupling for Neutronic Calculation with Temperature Feedback. Submitted to Nuclear Engineering and Design.

Here reported in `.bib` format
```latex
@article{OFELIA_2024,
title = {{OFELIA: an OpenMC-FEniCSx Coupling for Neutronic Calculation with Temperature Feedback}},
journal = {submitted to Nuclear Engineering and Design},
volume = {},
pages = {},
year = {2024},
issn = {},
doi = {},
url = {},
author = {Lorenzo Loi and Stefano Riva and Carolina Introini and Francesca Giacobbo and Xiang Wang and Antonio Cammi},
}
```

Expand Down
8 changes: 8 additions & 0 deletions generate_docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
cd docs/
sphinx-apidoc -force -o ./api/fenicsx/. ../models/fenicsx/

rm api/fenicsx/modules.rst
cp -r ../Tutorials . # needed since sphinx doesn't include parent directoris, the copied directory is not pushed

make clean
make html

0 comments on commit ce15437

Please sign in to comment.