symmy596 / intro_python_chemists

An Introduction to Python for Chemists

This is an open-source project to develop an introductory textbook covering all aspects of Python programming for chemistry students (at all career positions).

Current aim

Currently we are in the middle of the content creation sprint. The idea of this is that this sprint will last for at least three months (or until we have all the content we "want"). During this time, content does not need to be polished and the exact table of contents shape and structure is flexible. We have some ideas for content that we would like (see the issues), but if you have another idea please feel free.

In order to be as flexible as possible we are currently not focusing content order, so if it is not clear, your should include some prerequisites at the top of the section that you are adding.

Once this sprint is complete, we will move to a content curation sprint where we will work to clean up the content that has been written and develop in more detailed flow for the book, ensuring that each new section build on those previous! After this curation sprint it may be the case that new content becomes obvious (in which case we will go back to a creation sprint), or we may release the first version of the book.

The book will always exist as a living document, however major releases will be numbered appropriately.

Recognizing contributors

We welcome and recognize all contributions from writing new content to proof reading to improving figures. You can see a list of current contributors in the contributors tab.

If you would like to be involved, please look at the contributing guidelines.

On coding style

In this book we prioritise readibility and understandability of code over everything else. Therefore, the code herein will not necessarily adhere to PEP8 or any other standard, in particular if it sacrifices the educational utility of the material. All issues opened that are based purely on standard adherence will be closed without considering. However, we are open to issues and pull requests that discuss/improve coding style if the focus is on making the code clearer for the learner.