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.

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

changed title, tried a new acronyme #17

Merged
merged 1 commit into from
Sep 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
![Workflow Status](https://github.com/mdcourse/mdcourse.github.io/actions/workflows/tests.yml/badge.svg)
![Workflow Status](https://github.com/mdcourse/mdcourse.github.io/actions/workflows/gh-pages.yml/badge.svg)

# Learn Molecular Simulations with Python
# Step-by-Step Molecular Simulations with Python

<img src="docs/source/_static/logo/logo-py.png" width="30%" align="right"/></a>

The goal of [Learn Molecular Simulations with Python](https://mdcourse.github.io/)
is to write a simple code containing most of the basic functionalities of molecular
simulations, such as:
The goal of [Step-by-S Molecular Simulations with Python](https://mdcourse.github.io/)
(MoleSimPy) is to write a simple code containing most of the basic
functionalities of molecular simulations, including:
- Energy minimization,
- Molecular dynamics,
- Monte Carlo move.
Expand All @@ -30,9 +30,8 @@ The target audience includes people who are either completely new to molecular s
or users of open-source codes such as LAMMPS and GROMACS who want to better understand
what is behind those codes. Although some basic knowledge of coding, thermodynamics, and
statistical physics is recommended for a full understanding of molecular simulations,
[Learn Molecular Simulations with Python](https://mdcourse.github.io/) can be followed
even without deep expertise in these fields. Annexes with key concepts and suggested
readings are provided as needed.
[MoleSimPy](https://mdcourse.github.io/) can be followed even without deep
expertise in these fields.

### What is not (yet) in the code

Expand Down Expand Up @@ -61,9 +60,3 @@ under the Marie Skłodowska-Curie grant agreement No 101065060.
All inputs, scripts, and data files are released under the GNU
General Public License v3.0. The released files have been uploaded
to [Zenodo](https://zenodo.org/), under its [DOI](https://zenodo.org/records/13624976).

### TODO

- Choose a different title? (Build Your Own Molecular Simulations with Python,
Create Molecular Simulations with Python, Construct Molecular Simulations with Python)
- Find a cool acronym. MS-PyLearn, LMS-py ?
13 changes: 4 additions & 9 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
.. learn-ms-with-python documentation master file, created by
sphinx-quickstart on Thu Aug 24 10:18:57 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Learn molecular simulations with Python
=======================================
Step-by-Step Molecular Simulations with Python
==============================================

.. toctree::
:maxdepth: 2
Expand All @@ -25,7 +20,7 @@ Goals
:align: right
:class: only-light

By following Learn Molecular Simulations with Python, you will write a simple Python
By following *Step-by-Step Molecular Simulations with Python* (MoleSimPy), you will write a simple Python
code containing the most basic functionalities of molecular dynamics and Monte Carlo
simulations. The main goal is to help users understand the basics of molecular simulation
algorithms.
Expand All @@ -43,7 +38,7 @@ Prerequisites
This course is designed for complete beginners in molecular simulations,
as well as for those familiar with black-box software like LAMMPS and GROMACS.
Although some prior knowledge of coding and statistical physics would be useful,
Learn Molecular Simulations with Python can be followed by anyone with a computer.
MoleSimPy can be followed by anyone with a computer.

.. toctree::
:maxdepth: 2
Expand Down