WIP: Documentation for v2.

[ifokkema]

NOTE: This is a draft. Do not merge.

Since this project is currently private, some features of GitHub are disabled. One of those features is draft PRs, that can not be merged unless they are converted into non-draft PRs. This is a draft. We're not done yet, so please don't merge :wink:

Work In Progress (WIP): Documentation for v2.

@bjbvoesenek This is to show you what I currently have. We can work together in this branch to finish the documentation, as long as we communicate with each other when to push or pull the code.

We can easily reformat this manual in any way you see fit for your project. I do highly recommend keeping it in version control, in other words, keep using Markdown. We can always generate PDFs from this Markdown. You can see the Markdown rendering of this branch here.

Left to do:

• [x] Add versions of requirements? See the TODO in the text.
• [x] What Python version do we need?
• [ ] Standard Python libraries can be removed from the list.
• [ ] Perhaps the project needs a requirements.txt for pip to work with?
• [ ] Explain each output file? See the TODO in the text.
• [x] Should we include screenshots etc? If so, we'll need a separate directory to dump those pictures in, e.g., a docs folder.
• [ ] The Markdown can be rendered into PDF; I can add the instructions on how to do so in the code of the Markdown without being visible in the text.

[ifokkema]

@bjbvoesenek Any comments on this PR? This PR, the questions written above, and a final look at #8 is what's blocking the 2.0 release.

[bjbvoesenek]

I promised to have a look at the versions and create a manual. I'll make a manual for the python part in Markdown tomorrow. I work from home, so no distractions from labwork!

I will also look up the versions of python and the packages used

[bjbvoesenek]

Sorry that I forget a bit about this:)

[ifokkema]

I promised to have a look at the versions and create a manual. I'll make a manual for the python part in Markdown tomorrow. I work from home, so no distractions from labwork!

Excellent! If you pull in the v2/docs branch and continue working there, we'll have the same code. Everything can be added in just the same README.md.

I will also look up the versions of python and the packages used

Excellent!

Sorry that I forget a bit about this:)

No worries!

[bjbvoesenek]

Hereby the versions of python and packages used:

python 3.6.13 matplotlib 3.3.4 natsort 8.2.0 numpy 1.19.5 pandas 0.23.0 pip 21.2.2 xlrd 1.2.0

For the following packages I can't find a version, but as they are python build-in packages there maybe is no need to mention versions of these packages. I saw that others also don't list these: argparse math os sys statistics

[ifokkema]

Hereby the versions of python and packages used: (...)

We'll have to move this to another PR; if I will add this to this version of the manual, there is only more work to do merging the two manuals.