Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Added mkdocs #57

Merged
merged 2 commits into from
Apr 19, 2024
Merged

Added mkdocs #57

merged 2 commits into from
Apr 19, 2024

Conversation

shimwell
Copy link
Collaborator

Also needs a random function to show docstrings for

import typing

def csg_to_cad(
    csg_filename: str,
    csg_format: str,
    output_filename: str,
    bounding_box: typing.Tuple(float),
) -> str:
    """Converts a CSG geometry into a CAD geometry and saves a STEP file

    Args:
        csg_filename (str): the filename of the CSG file
        csg_format (str): the format / Monte Carlo code of the CSG file.
            Acceptable options are 'openmc', 'mcnp', 'serpent'
        bounding_box (typing.Tuple): A bounding box for the geometry in the
            format lower left x,y,z and upper right x,y,z
        output_filename (str): the filename of the produced CAD file

    Returns:
        str: output file path of the CAD file produced
    """
    return 'hello world'

def cad_to_csg(
    cad_filename: str,
    csg_format: str,
    output_filename: str,
    start_cell_id: int,
) -> str:
    """Converts a CAD geometry into a CSG geometry in the specified format

    Args:
        cad_filename (str): the filename of the CAD file
        csg_format (str): the format / Monte Carlo code of the CSG file.
            Acceptable options are 'openmc', 'mcnp', 'serpent'
        output_filename (str): the filename of the produced CSG file
        start_cell_id (typing.Tuple): A bounding box for the geometry in the
            format lower left x,y,z and upper right x,y,z

    Returns:
        str: output file path of the CSG file produced
    """
    return 'hello world'

@psauvan psauvan merged commit 1a46bcd into GEOUNED-org:dev Apr 19, 2024
6 checks passed
@shimwell
Copy link
Collaborator Author

ah sorry I made a few mistakes in this PR, I mean to make the PR on my own fork and finish it before making it here. Really sorry I shall fix it asap

@shimwell shimwell mentioned this pull request Apr 19, 2024
psauvan added a commit that referenced this pull request Apr 23, 2024
* update Fuzzy write function

* several stp file update

* script to color CAD document following material label

* fix rounding error of z value acos(z) evaluation

* Add a bug report template and .gitignore (#44)

* Removed unused imports and variables (#35)

* raise value error instead of exit (#41)

* Update to testing path (#40)

* changed hardcoded path to work for all users

* path update

* Update bug_report.md

* raising catchable error instead of exit (#47)

* raising catchable error instead of exit

* added new line

* added try for freecad import (#48)

* Solve SyntaxtError producing a bug (#49)

* Solve SyntaxtError producing a bug

* Limit the amount of decimals printed in the enclosure comment

* fixed error units in OpenMC output

* GEOUNED training presentation added (#53)

* Adding minimal ci to check cad converts (#52)

* added minimal CI

* all step files

* added ci yml

* removed freecadcmd arg

* Update pyproject.toml

Update url links to "GEOUNED-org"

* typo correction to test if CI is working (#54)

* typo correction

* [skip ci] added ci status badge

* opening up ci to all os systems

* fix small bug with torus (bad identification of closed mozaic faces)

* Adding minimal volume checking CI comparing CAD and CSG volumes (#56)

* added volume test to ci

* removed if os cond

* added csg vs cad volume for **most** stp files

* Added mkdocs (#57)

* added example docs

* added docs deps

* Reverting mkdocs PR 57 (#58)

* Revert "added example docs"

This reverts commit bd1c67a.

* Revert "added docs deps"

This reverts commit f31d241.

* Adding minimal particle transport tests on resulting csg files (#59)

* added transport tests

* removed files that break, raised issue

* [skip ci] remove prints

* added link to issue

* Add the name to the cells in OpenMC to improve identification (#61)

The name is the same that is used in MCNP inputs cell.Comments

* converting with no simplification = more geometry works (#62)

* reduced number of skiped geoms (#63)

* [skip ci] corrected bade to main branch (#64)

* Improved import statements (#65)

* changed single file from package to relative imports

* 2nd file converted to relative imports

* converted more fiels to relative import

* relative imports everywhere

* isort on all imports

* Add bug report and .gitignore to main (#45) (#66)

Co-authored-by: AlvaroCubi <55387701+AlvaroCubi@users.noreply.github.com>

* added standard gitignore for python project (#68)

---------

Co-authored-by: psauvan <psauvan@ind.uned.es>
Co-authored-by: Tony <63453741+repositony@users.noreply.github.com>
Co-authored-by: Jonathan Shimwell <drshimwell@gmail.com>
Co-authored-by: Aljaz Kolsek (F4E) <158494312+aljaz-kolsek@users.noreply.github.com>
Co-authored-by: Emilio Castro <emilio.castro@upm.es>
@AlvaroCubi AlvaroCubi mentioned this pull request Apr 24, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants