Skip to content

Commit 220dfd8

Browse files
authored
Review readme 2018 09 08 (#13)
* Review of Readme * fix typos * change order of media * more finetuning * improve Portuguese version link * point to online location * add self-reference * add note on target audience
1 parent c6ca1c8 commit 220dfd8

File tree

1 file changed

+49
-12
lines changed

1 file changed

+49
-12
lines changed

Readme.md

Lines changed: 49 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,22 @@
77
<img src="https://github.com/fangohr/introduction-to-python-for-computational-science-and-engineering/raw/master/static/images/titlepage.png" style="float" align="right" width="30%">
88
</a>
99

10-
An introduction to Python for Computational Science and
11-
Engineering, developed by Hans Fangohr (2003-2017 University of Southampton)
10+
An [Introduction to Python for Computational Science and
11+
Engineering](https://github.com/fangohr/introduction-to-python-for-computational-science-and-engineering/blob/review-readme-2018-09-08/Readme.md), developed by Hans Fangohr (2003-2018).
1212

13-
The book is available as
13+
The content and methods taught are intended for a target audience of
14+
scientists and engineers who need to use computational methods and
15+
data processing in their work, but typically have no prior programming
16+
experience or formal computer science training.
1417

18+
The book is available
19+
- [pdf](https://github.com/fangohr/introduction-to-python-for-computational-science-and-engineering/raw/master/pdf/Introduction-to-Python-for-Computational-Science-and-Engineering.pdf) ([version](pdf/version.txt))
1520
- interactively [as Jupyter Notebooks on MyBinder](https://mybinder.org/v2/gh/fangohr/introduction-to-python-for-computational-science-and-engineering/master?filepath=index.ipynb); probably the most attractive version of the book as any code examples can be executed and modified immediately to explore the language and improve one's understanding.
1621
([Use JupyterLab](https://mybinder.org/v2/gh/fangohr/introduction-to-python-for-computational-science-and-engineering/master?urlpath=lab/tree/index.ipynb) instead of the traditional Notebook.)
17-
1822
- html ([online](https://fangohr.github.io/introduction-to-python-for-computational-science-and-engineering/)
19-
or [in this zip file in the docs folder](https://github.com/fangohr/introduction-to-python-for-computational-science-and-engineering/archive/master.zip)
20-
- [pdf](https://github.com/fangohr/introduction-to-python-for-computational-science-and-engineering/raw/master/pdf/Introduction-to-Python-for-Computational-Science-and-Engineering.pdf)
23+
or [in this zip file in the docs folder](https://github.com/fangohr/introduction-to-python-for-computational-science-and-engineering/archive/master.zip)) ([version](docs/version.txt))
2124
- downloadable Jupyter Notebook files (`*.ipynb`) ([in this zip file](https://github.com/fangohr/introduction-to-python-for-computational-science-and-engineering/archive/master.zip))
25+
- [most recent sources and materials on Github (this page)](https://github.com/fangohr/introduction-to-python-for-computational-science-and-engineering/blob/review-readme-2018-09-08/Readme.md)
2226

2327

2428

@@ -30,9 +34,9 @@ is
3034

3135
# Translation
3236

33-
The book is available in portugese from https://github.com/gcpeixoto/lecture-ipynb ([pdf](https://github.com/gcpeixoto/lecture-ipynb/raw/master/pdf/Introducao-Python-para-Ciencias-Computacionais-Engenharia.pdf))
37+
The [book is available in Portuguese](https://github.com/gcpeixoto/lecture-ipynb/blob/master/README.md) ([pdf](https://github.com/gcpeixoto/lecture-ipynb/raw/master/pdf/Introducao-Python-para-Ciencias-Computacionais-Engenharia.pdf)).
3438

35-
# Ackwnowledgements
39+
# Acknowledgments
3640

3741
Thanks go to Thomas Kluyver, Neil O'Brien, Jacek Generowicz, and Mark
3842
Molinari for various contributions (see last chapter for
@@ -45,21 +49,54 @@ project (#676541).
4549

4650
# Feedback?
4751

48-
If you have used these materials and have some feedback, please get in
49-
touch (hans.fangohr@xfel.eu or fangohr@soton.ac.uk).
52+
If you have used these materials and have some feedback (positive or
53+
negative), please get in touch (hans.fangohr@xfel.eu or
54+
fangohr@soton.ac.uk).
55+
56+
# Favour request and citation
57+
58+
If you are using the book (be it as a teacher in your lecture course,
59+
as a student to support your learning, or in any other role), please
60+
send a short message to hans.fangohr@xfel.eu . Ideally, this would
61+
contain at which university/institution/company you are and how you
62+
use the book (in one sentence). This kind of data is useful to support
63+
further maintenance and extensions of the materials.
64+
65+
Please use this citation:
66+
67+
* Hans Fangohr, *Python for Computational Science and Engineering*,
68+
2018, [github.com/fangohr/introduction-to-python-for-computational-science-and-engineering](https://github.com/fangohr/introduction-to-python-for-computational-science-and-engineering/blob/master/Readme.md)
5069

5170
# License
5271

5372
<a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc/4.0/88x31.png" /></a><br />This work is
5473
<a href="https://raw.githubusercontent.com/fangohr/introduction-to-python-for-computational-science-and-engineering/master/LICENSE.TXT">licensed</a> under a <a rel="license" href="http://creativecommons.org/licenses/by-nc/4.0/">Creative Commons Attribution-NonCommercial 4.0 International License</a>.
5574

5675
The book can be downloaded, used and re-distributed for non-commercial
57-
purposes, i.e in particular for education purposes at universities, research institutes and schools.
76+
purposes, i.e in particular for education purposes at universities,
77+
research institutes and schools. Please send a message to the author
78+
if you do so.
79+
80+
81+
# Author
82+
83+
Hans Fangohr is a researcher and teacher (see
84+
[homepage](https://fangohr.github.io),
85+
[blog](https://fangohr.github.io/blog),
86+
[twitter](https://twitter.com/ProfCompMod)). His interests
87+
include effective software engineering for computational science and
88+
data science, researching computational modelling and data analysis
89+
methods, and education. He is a Professor at the [University of
90+
Southampton (UK)](http://www.southampton.ac.uk) and Data Analysis
91+
Scientist at the [European X-ray Free Electron Laser (EuXFEL)
92+
facility (Germany)](https://xfel.eu).
93+
94+
5895

5996

6097
----
6198

6299
Historical note: CI was done on [Circle
63100
CI](https://circleci.com/gh/fangohr/introduction-to-python-for-computational-science-and-engineering)
64-
until 23 August, then switched to [Travis
101+
until 23 August 2018, then switched to [Travis
65102
CI](https://travis-ci.org/fangohr/introduction-to-python-for-computational-science-and-engineering).

0 commit comments

Comments
 (0)