Skip to content

Commit

Permalink
Review readme 2018 09 08 (#13)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
fangohr committed Sep 8, 2018
1 parent c6ca1c8 commit 220dfd8
Showing 1 changed file with 49 additions and 12 deletions.
61 changes: 49 additions & 12 deletions Readme.md
Expand Up @@ -7,18 +7,22 @@
<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%">
</a>

An introduction to Python for Computational Science and
Engineering, developed by Hans Fangohr (2003-2017 University of Southampton)
An [Introduction to Python for Computational Science and
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).

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

The book is available
- [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))
- 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.
([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.)

- html ([online](https://fangohr.github.io/introduction-to-python-for-computational-science-and-engineering/)
or [in this zip file in the docs folder](https://github.com/fangohr/introduction-to-python-for-computational-science-and-engineering/archive/master.zip)
- [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)
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))
- downloadable Jupyter Notebook files (`*.ipynb`) ([in this zip file](https://github.com/fangohr/introduction-to-python-for-computational-science-and-engineering/archive/master.zip))
- [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)



Expand All @@ -30,9 +34,9 @@ is

# Translation

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))
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)).

# Ackwnowledgements
# Acknowledgments

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

# Feedback?

If you have used these materials and have some feedback, please get in
touch (hans.fangohr@xfel.eu or fangohr@soton.ac.uk).
If you have used these materials and have some feedback (positive or
negative), please get in touch (hans.fangohr@xfel.eu or
fangohr@soton.ac.uk).

# Favour request and citation

If you are using the book (be it as a teacher in your lecture course,
as a student to support your learning, or in any other role), please
send a short message to hans.fangohr@xfel.eu . Ideally, this would
contain at which university/institution/company you are and how you
use the book (in one sentence). This kind of data is useful to support
further maintenance and extensions of the materials.

Please use this citation:

* Hans Fangohr, *Python for Computational Science and Engineering*,
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)

# License

<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
<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>.

The book can be downloaded, used and re-distributed for non-commercial
purposes, i.e in particular for education purposes at universities, research institutes and schools.
purposes, i.e in particular for education purposes at universities,
research institutes and schools. Please send a message to the author
if you do so.


# Author

Hans Fangohr is a researcher and teacher (see
[homepage](https://fangohr.github.io),
[blog](https://fangohr.github.io/blog),
[twitter](https://twitter.com/ProfCompMod)). His interests
include effective software engineering for computational science and
data science, researching computational modelling and data analysis
methods, and education. He is a Professor at the [University of
Southampton (UK)](http://www.southampton.ac.uk) and Data Analysis
Scientist at the [European X-ray Free Electron Laser (EuXFEL)
facility (Germany)](https://xfel.eu).




----

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

0 comments on commit 220dfd8

Please sign in to comment.