zijiewu3 / mbuild_ona Goto Github PK
View Code? Open in Web Editor NEWA preliminary implementation of the ONA model (Ghobadi and Jayaraman, Soft Matter, 2016, 12, 2276) on MoSDeF platform (https://mosdef.org).
License: Other
A preliminary implementation of the ONA model (Ghobadi and Jayaraman, Soft Matter, 2016, 12, 2276) on MoSDeF platform (https://mosdef.org).
License: Other
Hey everyone! Awesome first mBuild plug-in! I noticed some things in the readme file that could be edited to improve its readability.
A preliminary implementation of the ONA model (Ghobadi and Jayaraman, Soft Matter, 2016, 12, 2276) on MoSDeF platform (https://mosdef.org).
Guide for testers: 1.Create a new conda env, and install mbuild and foyer. In linux shell, conda create -n mosdef35 -c mosdef -c conda-forge -c omnia mbuild foyer python=3.7 openbabel 2.Install mbuild_ONA. Download or clone this repo and run pip install -e . 3.Refer to example.py or example_from_mbuild.py
First, when creating numbered lists, you need to have them on new lines for the markdown rendering engine to recognize it. for Example:
Guide for testers: 1.Create a new conda env, and install mbuild and foyer. In linux shell, conda create -n mosdef35 -c mosdef -c conda-forge -c omnia mbuild foyer python=3.7 openbabel 2.Install mbuild_ONA. Download or clone this repo and run pip install -e . 3.Refer to example.py or example_from_mbuild.py
I would structure the readme file like this below:
A preliminary implementation of the ONA model (Ghobadi and Jayaraman, Soft Matter, 2016, 12, 2276) on MoSDeF platform (https://mosdef.org).
Guide for testers:
1. Create a new conda env, and install mbuild and foyer.
* In linux shell:
* `conda create -n mosdef37 -c mosdef -c conda-forge -c omnia mbuild foyer python=3.7 openbabel`
1. Install mbuild_ONA.
1. Refer to `example.py` or `example_from_mbuild.py`
A preliminary implementation of the ONA model (Ghobadi and Jayaraman, Soft Matter, 2016, 12, 2276) on MoSDeF platform (https://mosdef.org).
Guide for testers:
conda create -n mosdef37 -c mosdef -c conda-forge -c omnia mbuild foyer python=3.7 openbabel
pip install -e .
example.py
or example_from_mbuild.py
You do not have to number things yourself, leaving them all as 1.
will suffice and markdown will render the numbers properly. No need to keep editing them yourself!
*
are used for bullet points, put spaces before them to denote how tabbed they are
Back-tics ` put the text contained between them in a shell-like style, useful to show commands and such.
In the grey large section above, show the raw text of the readme file with my changes in it. You can then use that as a reference when editing the readme!
here is a great set of information about markdown and how GitHub uses it!
https://guides.github.com/features/mastering-markdown/#intro
Just a couple additions that would really improve the usability of the package:
Continuous integration: You can integrate this GitHub repo with continuous integration. In MoSDeF, we use both TravisCI and Azure Pipelines. You can checkout the mBuild
repo as an example.
Adding a workflow into mosdef_workflows: It would be really cool to see this recipe in action as a Jupyter Notebook.
A snapshot on the README always looks cool
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.