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

Jump to bottom

Complete readme info #2

Merged
merged 2 commits into from
Jun 4, 2022
Merged

Complete readme info #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
658e071
Update readme
kevinshen56714 Jun 4, 2022
d49e3ab
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jun 4, 2022
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
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
# Enhanced Monte Carlo (EMC) Python Interface

The `pyemc` module is a thin Python layer around the [EMC](http://montecarlo.sourceforge.net/emc/Welcome.html) package that allows you to use EMC with ease.
This Python module is a thin layer around the [EMC](http://montecarlo.sourceforge.net/emc/Welcome.html) package that allows you to use EMC with ease.

The package should work out of the box without any configuration as the pre-compiled EMC executable files are included. Please open an issue if you find something missing or not working as expected.

[![PyPI version shields.io](https://img.shields.io/pypi/v/emc-pypi.svg?style=for-the-badge&logo=PyPI&logoColor=blue)](https://pypi.python.org/pypi/emc-pypi/)
[![PyPI download month](https://img.shields.io/pypi/dm/emc-pypi.svg?style=for-the-badge&logo=PyPI)](https://pypi.python.org/pypi/emc-pypi/)
[![PyPI download day](https://img.shields.io/pypi/dd/emc-pypi.svg?style=for-the-badge&logo=PyPI)](https://pypi.python.org/pypi/emc-pypi/)

## Installation

```bash
pip install pmd
pip install emc-pypi
```


Expand All @@ -15,9 +20,9 @@ pip install pmd
```python
import pyemc

# Equivalent to running ./emc_setup.pl your-setup-file.esh on the command line
# Run the emc_setup.pl and prepare the build.emc file for the following build command
pyemc.setup('your-setup-file.esh')

# Equivalent to running the emc executable
# Run the emc executable
pyemc.build('build.emc')
```
```
1 change: 0 additions & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import os
import sys

from setuptools import find_packages, setup

Expand Down