Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Fix readme #37

Merged
merged 6 commits into from
May 9, 2017
Merged

Fix readme #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9af0703
Update README for current status
gonuke May 5, 2017
92449fd
Add hyperlinks
gonuke May 5, 2017
1975810
fix bold
gonuke May 5, 2017
fa0a709
Update license dates
gonuke May 5, 2017
c8187c7
minor editing and update Authors
gonuke May 9, 2017
d622c69
add space
gonuke May 9, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions AUTHORS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@ The following individuals have made contributions to the mcnp2cad project.

* Andrew Davis
* Steve Jackson
* Patrick Shriwise
* Ellis Wilson
* Paul P.H. Wilson
2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2011-2014, University of Wisconsin-Madison
Copyright (c) 2011-2017, University of Wisconsin-Madison
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
28 changes: 21 additions & 7 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,21 @@ MCNP2CAD README
MCNP to iGeom/CAD converter: a program to extract the geomtery from MCNP
input files and write it out using any ITAPS iGeom backend.

This project is currently in transition based on changes to the underlying CGM
library, with modified versions available as `a runtime plugin
<http://github.com/svalinn/DAGMC-Trelis>`_ to Trelis for an ACIS based
implementation and as a tool in `the CGM-ANL project
<http://sigma.mcs.anl.gov/cgm-library/>`_ for OpenCascade based
implementation.
**This project is currently in transition based on changes to the underlying
CGM library. The end state of this code will be a library that relies upon an
iGeom-like implementation to perform the solid model manipulations. That
iGeom-like implementation will be supported by other groups.**

Bug reports are appreciated.
The following groups intend to support such implementations:

* CNERG_ will develop an iGeom-like interface as part of a Trelis_ & Cubit_
plugin that uses this library to import MCNP geometry into Trelis/Cubit.

* The SIGMA_ team will develop an iGeom-like interface as part of an
implementation of CGM_ that is based on the OpenCascade_ solid modeling
engine. This version may support a command line tool.

Bug reports are appreciated - please post an issue in our `Github repository <https://github.com/svalinn/mcnp2cad/issues>`_.

This tool is based on an concept first developed at Argonne National
Laboratory.
Expand Down Expand Up @@ -48,3 +55,10 @@ Unsupported Features:
* Robust error detection and reporting for ill-formed MCNP inputs.


.. _CNERG: http://cnerg.engr.wisc.edu
.. _Trelis: http://csimsoft.com
.. _Cubit: http://cubit.sandia.gov
.. _SIGMA: http://sigma.mcs.anl.gov
.. _CGM: http://sigma.mcs.anl.gov/cgm-library/
.. _OpenCascade: https://www.opencascade.com/