File tree Expand file tree Collapse file tree 2 files changed +15
-7
lines changed Expand file tree Collapse file tree 2 files changed +15
-7
lines changed Original file line number Diff line number Diff line change @@ -12,25 +12,28 @@ information file (.[cif]) and the Large-scale Atomic Molecular Massively
1212Parallel Simulator ([ Lammps] ).
1313
1414## Installation
15+ Simply install from [ PyPI] ( https://pypi.org/project/lammps-interface/ ) :
1516```
16- pip install -r requirements.txt
17+ pip install lammps-interface
1718```
18- The Python module can be installed globally by:
19+
20+ For development purposes, clone the repository and install it from source:
1921```
2022pip install -e .
2123```
22- Note: This adds ` lammps-interface ` to your ` PATH ` .
24+
25+ Note: In both cases, this adds ` lammps-interface ` to your ` PATH ` .
2326
2427## Usage
2528
2629### Command line interface
2730To see the optional arguments type:
2831```
29- ./ lammps-interface --help
32+ lammps-interface --help
3033```
3134To create [ Lammps] simulation files for a given cif file type:
3235```
33- ./ lammps-interface cif_file.cif
36+ lammps-interface cif_file.cif
3437```
3538This will create [ Lammps] simulation files with UFF parameters.
3639
Original file line number Diff line number Diff line change 44 requirements = f .read ().splitlines ()
55
66setup (
7- name = "lammps_interface" ,
8- version = "0.1" ,
7+ name = "lammps-interface" ,
8+ author = "Peter Boyd, Mohamad Moosavi, Matthew Witman" ,
9+ version = "0.1.1" ,
10+ license = "MIT" ,
11+ url = "https://github.com/peteboyd/lammps_interface" ,
912 description = "Automatic generation of LAMMPS input files for molecular dynamics simulations of MOFs" ,
13+ long_description = open ('README.md' ).read (),
14+ long_description_content_type = 'text/markdown' ,
1015 install_requires = requirements ,
1116 include_package_data = True ,
1217 packages = find_packages (),
You can’t perform that action at this time.
0 commit comments