From 658e071694865b16898aacc7278896521d73a8d4 Mon Sep 17 00:00:00 2001 From: kevinshen56714 Date: Fri, 3 Jun 2022 21:06:30 -0400 Subject: [PATCH 1/2] Update readme --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f9b0dbf..aef0139 100644 --- a/README.md +++ b/README.md @@ -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 ``` @@ -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') ``` \ No newline at end of file From d49e3abfe533de2ee247790e47bd8ef42eadb0b4 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sat, 4 Jun 2022 01:06:52 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- README.md | 2 +- setup.py | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index aef0139..34aa30c 100644 --- a/README.md +++ b/README.md @@ -25,4 +25,4 @@ pyemc.setup('your-setup-file.esh') # Run the emc executable pyemc.build('build.emc') -``` \ No newline at end of file +``` diff --git a/setup.py b/setup.py index c9d56b6..c3f9957 100644 --- a/setup.py +++ b/setup.py @@ -1,5 +1,4 @@ import os -import sys from setuptools import find_packages, setup