jddingemanse / awtiCodeDev

Development of code for and by Arba Minch University Water Technology Institute
1 stars 2 forks source link

awtiCode

Code developed by and for Arba Minch Water Technology Institute (AWTI) staff. The raw code can be found under the folder /code/, some corresponding data can be found under the folder /data/. Some of the code is shown as examples (or developed to be used as classroom materials) through Jupyter Notebooks. Any such notebooks you can find under the folder /notebooks/.

About awtiCode

Development of code under this repository is an initiative to let some AWTI staff gain experience in coding by (trying to) write relevant code for their colleagues.

Some of the code is organized as functions under a package, that you can install in your preferred Python coding environment. The code for the package is hosted under the repository jddingemanse/awtiCode.

Participating in awtiCode

Your feedback, input, questions and remarks are most welcome! You can check out the discussions - add your knowledge to an existing one, or open a new one. If you find something that is a problem or should truly be added or changed, you can describe that in a discussion, or even raise an issue.

If you want to join in coding (become a collaborator of awtiCodeDev), please contact Jan Dirk Dingemanse.

Installation of awtiCode as package

If you want to install awtiCode as a package, follow the below steps.

First, make sure git is installed. In anaconda prompt:

conda install git

If git is installed, you can install awtiCode with:

pip install git+https://github.com/jddingemanse/awtiCode.git

If that was successful, you should be able to import awtiCode into your Python working environment.

Using the package awtiCode

In your Python IDE (for example, Spyder or Jupyter Notebook):

import awtiCode

Under awtiCode, there are different modules:

For example, to use the function ftpChirpsExplore (under the module ftpChirps; to explore the directories and files available on the CHIRPS FTP server):

import awtiCode
awtiCode.ftpChirps.ftpChirpsExplore()

or, more efficiently:

from awtiCode.ftpChirps import ftpChirpsExplore
ftpChirpsExplore()

The package awtiCode is very much under development - by developing code for this repository and package, we are also learning to code ourselves. Current code might contain errors, and not yet all code is properly explained with comments or docstrings. If you run into any errors, please raise an issue on this repository. If things are unclear, please let us know as well.