Skip to content

Commit 700fd26

Browse files
vanderhevanderhe
committed
Kick off project and set up basic infrastructure
1 parent 19b0e56 commit 700fd26

15 files changed

Lines changed: 1870 additions & 1 deletion

File tree

‎.gitignore‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
*~
2+
*.bak
3+
*.sav
4+
*.pyc
5+
_gitmsg.saved.txt
6+
build
7+
_build
8+
_downloads
9+
__pycache__

‎AUTHORS.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
*******
2+
Authors
3+
*******
4+
5+
6+
People
7+
======
8+
9+
Main Fortnet developer:
10+
11+
* Tammo van der Heide (University of Bremen, Germany)
12+
13+
The following people (in alphabetic order by their family names) have
14+
contributed to fortnet-ase :
15+
16+
*

‎CONTRIBUTING.rst‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
***********************************
2+
Contributing code to fortnet-python
3+
***********************************
4+
5+
fortnet-python is an open source project, and everyone is welcome to contribute
6+
improvements and extensions, provided they are willing to provide their
7+
changes under the same license as fortnet-python itself (BSD-2-Clause).
8+
9+
10+
How to contribute
11+
=================
12+
13+
The preferred method is to fork the project on `github
14+
<https://github.com/vanderhe/fortnet-python/>`_), make your changes and then
15+
create a pull request. Your changes should be based on the default branch.
16+
17+
18+
Attribution
19+
===========
20+
21+
Every contributor is welcome to be listed in the `AUTHORS.rst` file. List
22+
yourself by including a change to `AUTHORS.rst` in your pull
23+
request. Contributors should be ordered alphabetically by their family name.
24+
25+
26+
Developer certificate of origin
27+
===============================
28+
29+
When you contribute to the project, your contribution must align with the
30+
`Developer Certificate of Origin
31+
<https://developercertificate.org/>`_::
32+
33+
Developer Certificate of Origin
34+
Version 1.1
35+
36+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
37+
1 Letterman Drive
38+
Suite D4700
39+
San Francisco, CA, 94129
40+
41+
Everyone is permitted to copy and distribute verbatim copies of this
42+
license document, but changing it is not allowed.
43+
44+
45+
Developer's Certificate of Origin 1.1
46+
47+
By making a contribution to this project, I certify that:
48+
49+
(a) The contribution was created in whole or in part by me and I
50+
have the right to submit it under the open source license
51+
indicated in the file; or
52+
53+
(b) The contribution is based upon previous work that, to the best
54+
of my knowledge, is covered under an appropriate open source
55+
license and I have the right under that license to submit that
56+
work with modifications, whether created in whole or in part
57+
by me, under the same open source license (unless I am
58+
permitted to submit under a different license), as indicated
59+
in the file; or
60+
61+
(c) The contribution was provided directly to me by some other
62+
person who certified (a), (b) or (c) and I have not modified
63+
it.
64+
65+
(d) I understand and agree that this project and the contribution
66+
are public and that a record of the contribution (including all
67+
personal information I submit with it, including my sign-off) is
68+
maintained indefinitely and may be redistributed consistent with
69+
this project or the open source license(s) involved.
70+
71+
72+
By issuing a pull request or contributing code in any other ways to the project,
73+
you explicitly declare that your contribution is in accordance with the
74+
Developer's Certificate of Origin as described above.
75+
76+
Please, also make sure, that all of your git commits contain your real name and
77+
email address; pseudonyms and anonymous contributions unfortunately can not be
78+
accepted.

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
BSD 2-Clause License
22

3-
Copyright (c) 2021, Tammo van der Heide
3+
Copyright (c) 2021, T. W. van der Heide
44
All rights reserved.
55

66
Redistribution and use in source and binary forms, with or without

‎README.rst‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
*************************************************************
2+
fortnet-python: Python Tools for the Fortnet Software Package
3+
*************************************************************
4+
5+
|license|
6+
|latest version|
7+
|doi|
8+
|issues|
9+
10+
fortnet-python provides tools to generate compatible datasets as well as extract
11+
results obtained by the neural network implementation
12+
`Fortnet <https://github.com/vanderhe/fortnet>`_.
13+
14+
|logo|
15+
16+
Installation
17+
============
18+
19+
|build status|
20+
21+
The package can be installed via conda-forge::
22+
23+
conda install fortnet-python
24+
25+
Alternatively, the package can be downloaded and installed via pip into the
26+
active Python interpreter (preferably using a virtual python environment) by::
27+
28+
pip install fortnet-python
29+
30+
or into the user space issueing::
31+
32+
pip install --user fortnet-python
33+
34+
Documentation
35+
=============
36+
37+
|docs status|
38+
39+
Consult following resources for documentation:
40+
41+
* `Step-by-step instructions with selected examples (Fortnet Recipes)
42+
<https://fortnet.readthedocs.io/>`_
43+
44+
Contributing
45+
============
46+
47+
New features, bug fixes, documentation, tutorial examples and code testing is
48+
welcome during the ongoing fortnet-python development!
49+
50+
The project is
51+
`hosted on github <https://github.com/vanderhe/fortnet-python/>`_.
52+
Please check `CONTRIBUTING.rst <CONTRIBUTING.rst>`_ for guide lines.
53+
54+
I am looking forward to your pull request!
55+
56+
License
57+
=======
58+
59+
fortnet-python is released under the BSD 2-clause license. See the included
60+
`LICENSE <LICENSE>`_ file for the detailed licensing conditions.
61+
62+
.. |logo| image:: ./utils/art/logo.svg
63+
:alt: Fortnet logo
64+
:width: 90
65+
:target: https://github.com/vanderhe/fortnet/
66+
67+
.. |license| image:: https://img.shields.io/github/license/vanderhe/fortnet-python
68+
:alt: BSD-2-Clause
69+
:scale: 100%
70+
:target: https://opensource.org/licenses/BSD-2-Clause
71+
72+
.. |latest version| image:: https://img.shields.io/github/v/release/vanderhe/fortnet-python
73+
:target: https://github.com/vanderhe/fortnet-python/releases/latest
74+
75+
.. |doi| image:: https://zenodo.org/badge/356394988.svg
76+
:target: https://zenodo.org/badge/latestdoi/356394988
77+
78+
.. |docs status| image:: https://readthedocs.org/projects/fortnet/badge/?version=latest
79+
:alt: Documentation Status
80+
:scale: 100%
81+
:target: https://fortnet-python.readthedocs.io/en/latest/
82+
83+
.. |issues| image:: https://img.shields.io/github/issues/vanderhe/fortnet-python.svg
84+
:target: https://github.com/vanderhe/fortnet-python/issues/
85+
86+
.. |build status| image:: https://img.shields.io/github/workflow/status/vanderhe/fortnet-python/Build%20and%20Test
87+
:target: https://github.com/vanderhe/fortnet-python/actions/

‎pyproject.toml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[build-system]
2+
requires = ['setuptools', 'wheel', 'numpy', 'h5py']
3+
build-backend = 'setuptools.build_meta'

‎setup.cfg‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[metadata]
2+
name = fortnet-python
3+
version = 0.1
4+
author = T. W. van der Heide
5+
author_email = vanderhe@uni-bremen.de
6+
url = https://github.com/vanderhe/fortnet-python
7+
description = Python Tools for the Fortnet Software Package
8+
long_description = file: README.rst
9+
long_description_content_type = text/x-rst
10+
license = BSD
11+
license_file = LICENSE
12+
platform = any
13+
classifiers =
14+
Intended Audience :: Developers
15+
License :: OSI Approved :: BSD License
16+
Programming Language :: Python :: 3 :: Only
17+
Programming Language :: Python :: 3.7
18+
Programming Language :: Python :: 3.8
19+
Programming Language :: Python :: 3.9
20+
Programming Language :: Python :: 3.7
21+
22+
[options]
23+
include_package_data = True
24+
package_dir =
25+
= src
26+
packages = fortformat
27+
28+
[options.packages.find]
29+
where = src

‎src/MANIFEST.in‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
include README.rst

‎src/README.rst‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
*******************************************
2+
FORTFORMAT: Basic Fortnet IO Format Classes
3+
*******************************************
4+
5+
These basic Python classes implement the Fortnet input and output file format.
6+
The Fnetdata class enables to create compatible HDF5 datasets, whereas the
7+
Fnetout class extracts certain properties of the HDF5 output for later analysis.
8+
The corresponding Python classes are referred to as:
9+
10+
Fnetdata
11+
Basic Fortnet input format Python class.
12+
13+
Fnetout
14+
Basic Fortnet output format Python class.
15+
16+
17+
Installation
18+
============
19+
20+
Please note, that this package has been tested for **Python 3.X**
21+
support. It additionally needs Numerical Python (the Numpy module).
22+
23+
System install
24+
--------------
25+
26+
You can install the script package via the standard 'python setup'
27+
mechanism. If you want to install it system-wide into your normal
28+
python installation, you simply issue::
29+
30+
python setup.py install
31+
32+
with an appropriate level of permission.
33+
34+
Local install
35+
-------------
36+
37+
Alternatively, you can install it locally in your home space, e.g.::
38+
39+
python setup.py install --user
40+
41+
If the local python install directory is not in your path, you should
42+
add this. For the bash shell you should include in .bashrc::
43+
44+
export PATH=$PATH:/home/user/.local/bin
45+
46+
47+
For developers
48+
--------------
49+
50+
To perform pylint static checking from the top level directory of the
51+
Fortnet project, use
52+
53+
pylint3 --rcfile utils/srccheck/pylint/pylintrc-3.ini tools/fortformat/src/*

‎src/fortformat/__init__.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#------------------------------------------------------------------------------#
2+
# fortnet-python: Python Tools for the Fortnet Software Package #
3+
# Copyright (C) 2021 T. W. van der Heide #
4+
# #
5+
# See the LICENSE file for terms of usage and distribution. #
6+
#------------------------------------------------------------------------------#

0 commit comments

Comments
 (0)