-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #338 from fusion-energy/update-readme-link
updated web links in readme
- Loading branch information
Showing
1 changed file
with
10 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,20 @@ | ||
|
||
[![N|Python](https://www.python.org/static/community_logos/python-powered-w-100x40.png)](https://www.python.org) | ||
|
||
[![CI testing](https://github.com/fusion-energy/paramak2/actions/workflows/ci.yml/badge.svg)](https://github.com/fusion-energy/paramak2/actions/workflows/ci.yml) | ||
[![CI testing](https://github.com/fusion-energy/paramak/actions/workflows/ci.yml/badge.svg)](https://github.com/fusion-energy/paramak/actions/workflows/ci.yml) | ||
|
||
[![documentation release](https://github.com/fusion-energy/paramak2/actions/workflows/documentation_update.yml/badge.svg)](https://github.com/fusion-energy/paramak2/actions/workflows/documentation_update.yml) | ||
[![documentation release](https://github.com/fusion-energy/paramak/actions/workflows/documentation_update.yml/badge.svg)](https://github.com/fusion-energy/paramak/actions/workflows/documentation_update.yml) | ||
|
||
[![PyPI release](https://github.com/fusion-energy/paramak/actions/workflows/python-publish.yml/badge.svg)](https://github.com/fusion-energy/paramak/actions/workflows/python-publish.yml) | ||
|
||
|
||
# Paramak | ||
|
||
Paramak python package allows rapid production of 3D CAD models and neutronics | ||
models of fusion reactors. The purpose of Paramak is to provide geometry for | ||
parametric studies. Paramak can create geometry in standard CAD formats such as | ||
STP, STL, BRep, HTML and DAGMC h5m. | ||
models of fusion reactors. | ||
|
||
The purpose of Paramak is to provide geometry for parameter studies and therefore the models are created from parameters. | ||
|
||
Paramak produces [CadQuery](https://github.com/CadQuery/CadQuery) objects which can easily be saved to CAD files in several formats (STEP, STL, BRep) and also readily convertable to DAGMC h5m neutronics geometry using tools such as [Cad-to_DAGMC](https://github.com/fusion-energy/cad_to_dagmc). | ||
|
||
:point_right: Please see the [Documentation](https://paramak.readthedocs.io) for installation, usage and API documentation. | ||
:point_right: Please see the [Online documentation](https://fusion-energy.github.io/paramak) for installation, usage and API documentation. |