Skip to content

Commit f8933c0

Browse files
author
Greg
committed
Update to README, license pre-transfer
1 parent 212f055 commit f8933c0

File tree

4 files changed

+92
-32
lines changed

4 files changed

+92
-32
lines changed

.gitignore

+38-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,40 @@
11
*.ipynb_checkpoints
22
*.Rhistory
3-
__pycache__
3+
__pycache__
4+
*.idea
5+
6+
_configtest.o.d
7+
cover/
8+
9+
build
10+
dist/
11+
tags
12+
13+
*.pyc
14+
*.png
15+
/*.egg-info
16+
*.so
17+
*.pyd
18+
*.c
19+
*.cpp
20+
*.sln
21+
*.pyproj
22+
*~
23+
*.pdf
24+
.#*
25+
*.lprof
26+
*.swp
27+
*.swo
28+
.DS_Store
29+
*.tar.gz
30+
*.tgz
31+
*.nt.bz2
32+
*.prof
33+
*.prefs
34+
.pydevproject
35+
.idea
36+
.vscode
37+
38+
.coverage
39+
.pytest_cache/
40+
.cache/

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2018 gregparkes
3+
Copyright (c) 2018- Gregory Parkes
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

+51-30
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,36 @@
1-
# LearnPython
2-
3-
Welcome to *LearnPython*.
4-
5-
The aim of this repository is to provide complex examples to the Python programming language and extended libraries. It contains many *multidisciplinary* examples to write code for, on a range of coding topic areas, particularly for research purposes.
1+
# Advanced Python Repository for Researchers and Students
2+
3+
Welcome to *University of Southampton VLC* repository
4+
for python learning and development.
5+
6+
The aim of this repository is to provide complex examples
7+
to the Python programming language and extended libraries.
8+
It contains many *multidisciplinary* examples to write
9+
code for, on a range of coding topic areas, particularly
10+
for research purposes.
11+
12+
## Topics covered
13+
14+
In this repository we break down areas of
15+
knowledge into the following categories:
16+
1. **Basics**: Learning the python programming language and
17+
in-built libraries
18+
2. **Scientific Computing and Simulation**: Learning packages `numpy`, `scipy` and `dask`,
19+
with a wealth of application problem domains to explore,
20+
including Monte Carlo, Stochastic Differential Equations and more. The performance
21+
aspects of simulation are also explored in detail.
22+
3. **Data analysis**: Learning how to load, preprocess, munge and work with
23+
tabular relational datasets using `pandas`, with additional focus on networks
24+
using `networkx`.
25+
4. **Visualisation**: Learning the best practices for visualising results
26+
from a model or dataset, beginning with low-level tools like `matplotlib` but moving
27+
on to interactive tools like `bokeh`, `plotly` and `seaborn`.
28+
5. **Machine Learning**: Learning the basics of machine learning from a
29+
mathematical, statistical and applicational basis, including classification, regression,
30+
dimensionality reduction and clustering using `sklearn`.
31+
32+
We recommend you explore them in the order presented, but there is no hard
33+
prerequisite for any section.
634

735
## Principles and Basics
836

@@ -68,40 +96,33 @@ Users will become very familiar with basic plots, and will progress onto animate
6896

6997
***
7098

99+
### References
100+
71101
Inspirations:
72102
1. https://github.com/ageron/handson-ml
73103
2. https://github.com/jakevdp/PythonDataScienceHandbook
104+
3. Wikipedia
74105

75-
***
106+
### Installation
76107

77-
The course is covered as interactive Jupyter notebooks which makes things considerably easier. In order to follow this course, we recommend you download Python using the Anaconda distribution (found [here](https://www.anaconda.com/download/)) as this also provides most of the packages used in this course.
108+
Requirements for each subdirectory are stated in the respective README files.
78109

79110
***
80111

81-
Ensure that any use of this material is appropriately referenced and in compliance with the license.
112+
We have further notebooks which weren't clearly grouped into a particular section
113+
added in the `Extras/` folder.
82114

83-
All rights reserved.
115+
The course is covered as interactive Jupyter notebooks which
116+
makes things considerably easier. In order to follow this
117+
course, we recommend you download Python using the
118+
Anaconda distribution
119+
(found [here](https://www.anaconda.com/download/)) as
120+
this also provides most of the packages used
121+
in this course.
84122

85-
### License
86-
87-
MIT License
88-
89-
Copyright (c) 2018-19 Gregory Parkes
90-
91-
Permission is hereby granted, free of charge, to any person obtaining a copy
92-
of this software and associated documentation files (the "Software"), to deal
93-
in the Software without restriction, including without limitation the rights
94-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
95-
copies of the Software, and to permit persons to whom the Software is
96-
furnished to do so, subject to the following conditions:
123+
***
97124

98-
The above copyright notice and this permission notice shall be included in all
99-
copies or substantial portions of the Software.
125+
Ensure that any use of this material is appropriately
126+
referenced and in compliance with the license.
100127

101-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
102-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
103-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
104-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
105-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
106-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
107-
SOFTWARE.
128+
All rights reserved.

view_notebooks.sh

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# this script generates HTML versions of the jupyter notebooks to view in a web browser.
2+
13
# clear away current files
24
echo "[Clearing existing files]"
35
rm -r ViewDocs/*

0 commit comments

Comments
 (0)