Repo Taxonomy

[pghege]

Discussed in #20

^{Originally posted by pghege February 3, 2023}
AmpLabs Repo is a landing page for people who want to join the community and get started contributing. The structure of the repo should facilitate the following:

1. Help new members understand what we're doing and who we are
2. Have an easy 'win' to encourage new members to stay
3. Clear and Simple Guide to help new members contribute

Many users may have never contributed to an open source project before and may not know what being a member of a software community means.

This repository is primarily a well-formatted read-me document to help newcomers orient themselves. In addition, worked-examples showing useful or cool features should be highlighted here. Any code here is from the 'client' perspective. The cloud service and deployment will be available in another repo such as ampcloud-service.

Below I propose the following structure for amplabs. The folders are focused on technologies users recognize. The readme explains the structure or design behind the platform

/matlab/
/python/
/pybamm/
/beep/
/battery-archive/
/galvanalyser/
/readme.md