Skip to content
Snippets Groups Projects
Commit fff9b95e authored by Christoph.Knote's avatar Christoph.Knote
Browse files

Lot's a changes in documentation. Almost there now!

parent 78b82f1b
No related branches found
No related tags found
No related merge requests found
Changelog
=========
0.9.0 (2017-08-04)
------------------
- Initial release
::
pip install icartt
ICARTT file format reader and writer
====================================
=======
icartt
=======
Testing things out!
``icartt`` is an ICARTT format reader and writer
Check it out::
Documentation
=============
import icartt
ds = icartt.Dataset()
maintained at https://boxmodeling.meteo.physik.uni-muenchen.de/documentation
Version history
---------------
1 - 27.07.2017
Initial release
\ No newline at end of file
Installation
============
\ No newline at end of file
......@@ -12,12 +12,44 @@ icartt is an ICARTT file format reader and writer
.. contents::
:local:
:depth: 2
.. module:: icartt
Installation
------------
.. include:: ../../icartt/INSTALL.rst
Example
------------
::
import icartt
# load a new dataset from an existing file
ict = icartt.Dataset('path/to/example.ict')
# list variable names
ict.varnames
# e.g. ['Fractional_Day', 'UTC', 'JDAY', 'INDEX', 'FLIGHT', 'LOCAL_SUN_TIME', ...
# get data for variable 'UTC':
ict['UTC']
# some metadata
ict.organization
ict.dataSource
ict.mission
# write to (other) file:
with open('path/to/output.ict', 'wb') as f:
ict.write(f)
API
----
.. module:: icartt
Variable
^^^^^^^^^^
......
import os
from setuptools import setup
def read(filename):
with open(os.path.join(os.path.dirname(__file__), filename)) as f:
return f.read()
setup(name='icartt',
description='ICARTT format reader and writer',
version='1.0.0',
long_description=read('README.rst') + '\n\n' + read('INSTALL.rst') + '\n\n' + read('CHANGES.rst'),
version='0.9.0',
url='https://boxmodeling.meteo.physik.uni-muenchen.de',
author='Christoph Knote',
author_email='christoph.knote@physik.uni-muenchen.de',
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment