csg2csg

Tools to translate between different CSG geometry types

https://github.com/makeclean/csg2csg

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    2 of 8 committers (25.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.0%) to scientific vocabulary

Keywords from Contributors

neutron photon spectrum
Last synced: 7 months ago · JSON representation ·

Repository

Tools to translate between different CSG geometry types

Basic Info
  • Host: GitHub
  • Owner: makeclean
  • License: eupl-1.2
  • Language: Python
  • Default Branch: master
  • Size: 432 KB
Statistics
  • Stars: 39
  • Watchers: 11
  • Forks: 25
  • Open Issues: 22
  • Releases: 0
Created over 8 years ago · Last pushed 10 months ago
Metadata Files
Readme License Citation

README.md

CI test results

csg2csg

A tool to translate common Monte Carlo geometry formats between each other.

How to use

Right now the code is petty rough.

Install the latest version released on PyPi using pip bash pip3 install csg2csg --user

Install the latest version on the repository using pip bash pip install git+https://github.com/makeclean/csg2csg.git --user

Run from the terminal with csg2csg -i filename -f format where filename is the input filename and format is the file format of the input file. Options for the file format include several neutronics codes [mcnp, serpent, openmc, phits, fluka] each is at a different level of completeness.

The default is to attempt to translate the input file into all neutronics codes but users can specify which codes with the -o flag.

To see all the run options type csg2csg -h in the terminal

Caveats

Several! Right now only MCNP can be read, and then written to MCNP, Serpent and OpenMC. When the file can be read only a subset of MCNP surfaces can be read

MCNP Surfaces Supported - P,PX,PY,PZ - S SO SX SY SZ - CX CY CZ C/X C/Y C/Z - SQ - GQ - KX, KY, KZ - TX TY TZ - Macrobodies - RPP, SPH and RCC - X, Y, Z - one and two coefficent only

MCNP Surfaces Not Yet Supported - X, Y, Z - three coefficient - Macrobodies - BOX, RHP, HEX, REC, TRC, ELL, WEB, ARB

Transforms - Are read and interpretted, but nothing is done with them, in the future codes that support cell transformations will use it, but right now MCNP is the only code that does surface transformations

Owner

  • Name: Andrew Davis
  • Login: makeclean
  • Kind: user
  • Location: Oxford, UK
  • Company: United Kingdom Atomic Energy Authority @ukaea

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Davis"
  given-names: "Andrew"
- family-names: "Shimwell"
  given-names: "Jonathan"
  orcid: "https://orcid.org/0000-0001-6909-0946"
- family-names: "Lilley"
  given-names: "Steve"
- family-names: "Shriwise"
  given-names: "Patrick"
  orcid: "https://orcid.org/0000-0002-3979-7665"
title: "csg2csg: Tools to translate between different CSG geometry types "
version: 0.0.30 
date-released: 2021-3-2
url: "https://github.com/makeclean/csg2csg"

GitHub Events

Total
  • Watch event: 2
  • Issue comment event: 1
  • Push event: 1
  • Pull request event: 2
  • Fork event: 1
Last Year
  • Watch event: 2
  • Issue comment event: 1
  • Push event: 1
  • Pull request event: 2
  • Fork event: 1

Committers

Last synced: almost 2 years ago

All Time
  • Total Commits: 177
  • Total Committers: 8
  • Avg Commits per committer: 22.125
  • Development Distribution Score (DDS): 0.503
Past Year
  • Commits: 7
  • Committers: 1
  • Avg Commits per committer: 7.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Andrew Davis a****s@u****k 88
shimwell m****l@j****m 37
Andrew Davis a****s@g****m 29
py1sl s****y@s****k 12
Sam Mason s****m@s****k 7
Patrick Shriwise p****e@g****m 2
Andrew Davis a****s@w****u 1
Steve Lilley p****l 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 27
  • Total pull requests: 49
  • Average time to close issues: 5 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 10
  • Total pull request authors: 8
  • Average comments per issue: 1.52
  • Average comments per pull request: 0.86
  • Merged pull requests: 42
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 10 days
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 1.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • py1sl (10)
  • gvozdila (5)
  • shimwell (3)
  • makeclean (2)
  • gonuke (2)
  • thberry (1)
  • zxkjack123 (1)
  • daleher (1)
  • yardasol (1)
  • sbradnam (1)
Pull Request Authors
  • makeclean (21)
  • shimwell (12)
  • py1sl (7)
  • pshriwise (4)
  • ChasingNeutrons (2)
  • sbradnam (2)
  • rtswanson (1)
  • smason (1)
Top Labels
Issue Labels
bug (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 15 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 2
  • Total maintainers: 3
pypi.org: csg2csg

Convert CSG geometry into different formats

  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 15 Last month
Rankings
Forks count: 8.2%
Dependent packages count: 10.1%
Stargazers count: 11.9%
Average: 18.1%
Dependent repos count: 21.5%
Downloads: 38.4%
Last synced: 8 months ago

Dependencies

.github/workflows/ci.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
pyproject.toml pypi
  • numpy *