|
|
# EBAS IO
|
|
|
ebas-io is a python package for reading/writing NASA-Ames 1001 files with EBAS extensions (EBAS NASA-Ames).
|
|
|
|
|
|
## Contact and Support
|
|
|
If you have any questions please contact ebas@nilu.no.
|
|
|
|
|
|
## Version 3.4.0
|
|
|
|
|
|
>**Attention: changed behaviour of the EbasCommandline wrapper object!**
|
|
|
Starting with version 3.1.1, the EbasCommandline object does not automatically execute the main function. Now an explicit ```run()``` on the object is needed. Please consider this if you use the EbasCommandline wrapper in your scripts!
|
|
|
Example:
|
|
|
```python
|
|
|
EbasCommandline(
|
|
|
ebas_convert,
|
|
|
custom_args=['CONFIG', 'LOGGING', 'TIME_CRIT'],
|
|
|
private_args=add_private_args,
|
|
|
help_description='%(prog)s example for converting a NasaAmes datafile to '
|
|
|
'different dataformats', version=__version__).run()
|
|
|
```
|
|
|
* features and bug fixes in the main code base
|
|
|
* moved from egg top wheel packages
|
|
|
* ported to python3 (mind the two different versions in the dist directory)
|
|
|
|
|
|
## Downloading the software
|
|
|
Starting with version 3.00.13, the python egg is available in this git repository (dist folder) together with the example scripts. The idea behind the git repo ist to make it easier for users to contribute their software using ebas-io and make it available for other users.
|
|
|
The python wheel is available in this git repository (dist folder; mind the two different versions for python 2 and 3) together with the example scripts. The idea behind the git repo ist to make it easier for users to contribute their software using ebas-io and make it available for other users.
|
|
|
|
|
|
a) You can clone the repository with ```git clone https://git.nilu.no/ebas/ebas-io.git```
|
|
|
|
... | ... | @@ -29,25 +24,13 @@ Starting with version 3.00.13, the python egg is available in this git repositor |
|
|
In either way, you should finally end up with a directory called ```ebas-io```.
|
|
|
|
|
|
## Installation
|
|
|
The ebas-io package can be installed the standard way with easy_install. See the [setuptools](https://pypi.python.org/pypi/setuptools) documentation if easy_install does not work for you. The egg file can be found in the directory ```ebas-io/dist```
|
|
|
The ebas-io package can be installed using pip. See the [pip](https://pip.pypa.io/en/stable/) documentation if pip does not work for you. The whl files can be found in the directory ```ebas-io/dist```
|
|
|
|
|
|
```bash
|
|
|
easy_install ebas_io-3.0.13-py2.7.egg
|
|
|
pip install ebas_io-3.4.0-py3-none-any.whl
|
|
|
```
|
|
|
|
|
|
Please mind that you probably have to have administrator rights ('sudo easy_install ...' on linux/unix machines). Alternatively you may want to install the packages locally for your user (see --prefix in the [easy_install](http://setuptools.readthedocs.io/en/latest/easy_install.html) documentation).
|
|
|
|
|
|
|
|
|
>**Attention: changed package structure as of version 3.0.13!**
|
|
|
Starting with version 3.0.13, all nilu internal dependencies (nilutility, AtmosPhys, fileformats) are now included in the ebas-io egg. This means, the installation is now much simpler.
|
|
|
But: users having installed an earlier version should clean their python installation form this old extra packages before installing the new ebas-io package. This can be done as follows:
|
|
|
|
|
|
```bash
|
|
|
pip uninstall AtmosPhys
|
|
|
pip uninstall fileformats
|
|
|
pip uninstall nilutility
|
|
|
pip uninstall ebas-io
|
|
|
```
|
|
|
Please mind that you probably have to have administrator rights ('sudo pip ...' on linux/unix machines). Alternatively you may want to install the packages locally for your user (see the [--user] (https://pip.pypa.io/en/stable/user_guide/#user-installs) option in the pip documentation).
|
|
|
|
|
|
## Just want to test it?
|
|
|
|
... | ... | @@ -160,5 +143,27 @@ As an example for the Station code: The EbasMetadata class defines that the tag |
|
|
So, for knowing which EBAS metadata elements can be used at all, what's their tag in the NASA Ames file, and which key needs to be used in the IO object to set or retrieve the metadata element, the EbasMetdata object is the place to look for. Some examples of how to use that class can be found in an ipython Notebook under
|
|
|
```Examples/Doc/Notebooks/EbasMetadata.ipynb```. For users who are less familiar with git and ipython notebooks we provide a [static html version of the file](http://htmlpreview.github.io/?https://git.nilu.no/ebas/ebas-io/raw/master/Examples/Doc/Notebooks/html/EbasMetadata.html).
|
|
|
|
|
|
## Contact and Support
|
|
|
If you have any questions please contact ebas@nilu.no. |
|
|
\ No newline at end of file |
|
|
## Old Release Notes
|
|
|
|
|
|
>**Attention: changed behaviour of the EbasCommandline wrapper object!**
|
|
|
Starting with version 3.1.1, the EbasCommandline object does not automatically execute the main function. Now an explicit ```run()``` on the object is needed. Please consider this if you use the EbasCommandline wrapper in your scripts!
|
|
|
Example:
|
|
|
```python
|
|
|
EbasCommandline(
|
|
|
ebas_convert,
|
|
|
custom_args=['CONFIG', 'LOGGING', 'TIME_CRIT'],
|
|
|
private_args=add_private_args,
|
|
|
help_description='%(prog)s example for converting a NasaAmes datafile to '
|
|
|
'different dataformats', version=__version__).run()
|
|
|
```
|
|
|
|
|
|
>**Attention: changed package structure as of version 3.0.13!**
|
|
|
Starting with version 3.0.13, all nilu internal dependencies (nilutility, AtmosPhys, fileformats) are now included in the ebas-io egg. This means, the installation is now much simpler.
|
|
|
But: users having installed an earlier version should clean their python installation form this old extra packages before installing the new ebas-io package. This can be done as follows:
|
|
|
|
|
|
```bash
|
|
|
pip uninstall AtmosPhys
|
|
|
pip uninstall fileformats
|
|
|
pip uninstall nilutility
|
|
|
pip uninstall ebas-io
|
|
|
``` |