Skip to content

Commit

Permalink
Add BSD licenses
Browse files Browse the repository at this point in the history
  • Loading branch information
szaghi committed Jun 11, 2015
1 parent 03a8638 commit 44b56be
Show file tree
Hide file tree
Showing 10 changed files with 380 additions and 130 deletions.
36 changes: 19 additions & 17 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,31 @@ language: python
python:
- 2.7

env:
global:
- secure: ZfUM5EuWFnPXgyw7M/dz4deW8qmxGsrCZTSeeLUeJj6lQ/zhM9Dn259IL4SuA3Neji6WOLqm6Z7SmXjm7ieFmn2/Fshuz1KWsGe8XdHDm8PUsfj1XVOpZBKqyPLUv2CPxR+V22fDaAUX3UlWdaFhsWYJzVo3GYX2fJtshFjKDJw=
- APT_DEPENDS="gfortran-4.9 binutils"
- PIP_DEPENDS="FoBiS.py markdown-checklist ford"
matrix:
- SCRIPT="FoBiS.py rule -ex makecoverage"
ACTION="COVERAGE"
- SCRIPT="./makedoc.sh Lib_VTK_IO"
ACTION="MAKEDOC"

before_install:
- sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
- sudo apt-get update -qq
- sudo apt-get install gfortran-4.9

install:
- sudo apt-get install -y $APT_DEPENDS
- sudo pip install $PIP_DEPENDS
- ln -fs /usr/bin/gfortran-4.9 gfortran
- pip install FoBiS.py
- pip install markdown-checklist
- pip install ford
- ln -fs /usr/bin/gcov-4.9 gcov
- export PATH=".:$PATH"

before_script:
- FoBiS.py build -mode test-driver-gnu

script:
- ./Test_Driver/Test_Driver -unst
- $SCRIPT

after_success:
- git config --global user.name "Stefano Zaghi"
- git config --global user.email "[email protected]"
- git clone --quiet --branch=gh-pages https://${GH_TOKEN}@github.com/szaghi/Lib_VTK_IO doc/html
- FoBiS.py rule -ex makedoc
- cd doc/html
- git add -f --all *
- git commit -m "Travis CI autocommit from travis build ${TRAVIS_BUILD_NUMBER}"
- git push -fq origin gh-pages
- cd ../../
- cd $TRAVIS_BUILD_DIR
- if [[ $ACTION == COVERAGE ]]; then bash <(curl -s https://codecov.io/bash); fi
30 changes: 30 additions & 0 deletions LICENSE.bsd-2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Simplified BSD License
======================

Copyright © 2015, Stefano Zaghi

All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.
29 changes: 29 additions & 0 deletions LICENSE.bsd-3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Modified BSD License
====================

Copyright © 2015, Stefano Zaghi

All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the Lib_VTK_IO nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL Stefano Zaghi BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
82 changes: 71 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,17 @@

# Lib\_VTK\_IO [![GitHub tag](https://img.shields.io/github/tag/szaghi/Lib_VTK_IO.svg)]()

[![License](https://img.shields.io/badge/license-GNU%20GeneraL%20Public%20License%20v3%20,%20GPLv3-blue.svg)]()
[![License](https://img.shields.io/badge/license-GNU%20GeneraL%20Public%20License%20v3,%20GPLv3-blue.svg)]()
[![License](https://img.shields.io/badge/license-BSD2-red.svg)]()
[![License](https://img.shields.io/badge/license-BSD3-red.svg)]()
[![License](https://img.shields.io/badge/license-MIT-red.svg)]()

[![Status](https://img.shields.io/badge/status-stable-brightgreen.svg)]()
[![Build Status](https://travis-ci.org/szaghi/Lib_VTK_IO.svg?branch=master)](https://travis-ci.org/szaghi/Lib_VTK_IO)
[![Coverage Status](https://coveralls.io/repos/szaghi/Lib_VTK_IO/badge.svg?branch=master)](https://coveralls.io/r/szaghi/Lib_VTK_IO?branch=master)

### Lib\_VTK\_IO, VTK IO in pure Fortran (2003+)

A KISS pure Fortran Library to IO data conforming the VTK standard

+ Lib\_VTK\_IO is a pure Fortran library to write and read data conforming the [VTK standard](http://www.vtk.org/);
Expand All @@ -16,39 +21,93 @@ A KISS pure Fortran Library to IO data conforming the VTK standard
+ Lib\_VTK\_IO supports _ascii_, _binary_ and _base64_ file formats;
+ Lib\_VTK\_IO is a Free, Open Source Project.

#### Table of Contents

- [Main features](#main-features)
- [Copyrights](#copyrights)
- [Documentation](#documentation)
- [A Taste of Lib_VTK_IO](#a-taste-of-lib_vtk_io)

#### Issues

[![GitHub issues](https://img.shields.io/github/issues/szaghi/Lib_VTK_IO.svg)]()
[![Ready in backlog](https://badge.waffle.io/szaghi/Lib_VTK_IO.png?label=ready&title=Ready)](https://waffle.io/szaghi/Lib_VTK_IO)
[![In Progress](https://badge.waffle.io/szaghi/Lib_VTK_IO.png?label=in%20progress&title=In%20Progress)](https://waffle.io/szaghi/Lib_VTK_IO)
[![Open bugs](https://badge.waffle.io/szaghi/Lib_VTK_IO.png?label=bug&title=Open%20Bugs)](https://waffle.io/szaghi/Lib_VTK_IO)

#### Compiler Support
[![Compiler](https://img.shields.io/badge/GNU%20Gfortran%20Compiler-build%20pass%20with%20v4.9.2+-brightgreen.svg)]()

[![Compiler](https://img.shields.io/badge/Intel%20Fortran%20Compiler-build%20pass%20with%20v12.x+-brightgreen.svg)]()

[![Compiler](https://img.shields.io/badge/IBM%20XL%20Fortran%20Compiler-not%20tested-yellow.svg)]()
[![Compiler](https://img.shields.io/badge/GNU-pass%20(v4.9.2+)-brightgreen.svg)]()
[![Compiler](https://img.shields.io/badge/Intel-pass%20(v12.x+)-brightgreen.svg)]()
[![Compiler](https://img.shields.io/badge/IBM%20XL-not%20tested-yellow.svg)]()
[![Compiler](https://img.shields.io/badge/g95-not%20tested-yellow.svg)]()
[![Compiler](https://img.shields.io/badge/NAG-not%20tested-yellow.svg)]()
[![Compiler](https://img.shields.io/badge/PGI-not%20tested-yellow.svg)]()

## Main features

### VTK features

#### Exporters

##### Legacy standard
* [x] Structured Points;
* [x] Structured Grid;
* [x] Unstructured Grid;
* [ ] Polydata;
* [x] Rectilinear Grid;
* [ ] Field;

##### XML standard
* [ ] serial dataset:
* [ ] Image Data;
* [ ] Polydata;
* [x] Rectilinear Grid;
* [x] Structured Grid;
* [x] Unstructured Grid;
* [ ] parallel (partitioned) dataset:
* [ ] Image Data;
* [ ] Polydata;
* [x] Rectilinear Grid;
* [x] Structured Grid;
* [x] Unstructured Grid;
* [x] composite dataset:
* [x] vtkMultiBlockDataSet.

#### Importers
The importers are under developing.

### Parallel Architectures

Lib\_VTK\_IO can handle multiple concurrent files and it is \b thread/processor-safe, meaning that it can be safely used into parallel architectures using OpenMP and/or MPI paradigms. Into section [[Parallel-benchmarks]] some more details can be found.

[![Compiler](https://img.shields.io/badge/g95%20Fortran%20Compiler-not%20tested-yellow.svg)]()
## Copyrights

[![Compiler](https://img.shields.io/badge/NAG%20Fortran%20Compiler-not%20tested-yellow.svg)]()
Lib_VTK_IO is an open source project, it is distributed under a multi-licensing system:

[![Compiler](https://img.shields.io/badge/PGI%20Fortran%20Compiler-not%20tested-yellow.svg)]()
+ for FOSS projects:
- [GPL v3](http://www.gnu.org/licenses/gpl-3.0.html);
+ for closed source/commercial projects:
- [BSD 2-Clause](http://opensource.org/licenses/BSD-2-Clause);
- [BSD 3-Clause](http://opensource.org/licenses/BSD-3-Clause);
- [MIT](http://opensource.org/licenses/MIT).

## Copyrights
Anyone is interest to use, to develop or to contribute to Lib_VTK_IO is welcome, feel free to select the license that best matches your soul!

The Lib\_VTK\_IO is an open source project, it is distributed under a dual licensing system: the [GPL v3](http://www.gnu.org/licenses/gpl-3.0.html) and the [MIT](http://opensource.org/licenses/MIT) licenses. Anyone is interest to use, to develop or to contribute to Lib\_VTK\_IO is welcome: you are free to select the GPL license for FOSS projects or the MIT one for commercial softwares.
More details can be found on [wiki](https://github.com/szaghi/Lib_VTK_IO/wiki/Copyrights).

Go to [Top](#top)

## Documentation

Lib\_VTK\_IO has a comprehensive [wiki](https://github.com/szaghi/Lib_VTK_IO/wiki). Moreover, the API is well documented, on the [GitHub pages](http://szaghi.github.com/Lib_VTK_IO/index.html) of the project.
Besides this README file the Lib_VTK_IO documentation is contained into its own [wiki](https://github.com/szaghi/Lib_VTK_IO/wiki). Detailed documentation of the API is contained into the [GitHub Pages](http://szaghi.github.io/Lib_VTK_IO/index.html) that can also be created locally by means of [ford tool](https://github.com/cmacmackin/ford).

Go to [Top](#top)

### A taste of Lib\_VTK\_IO

Let us assume our aim being to save our pure Fortran data into a VTK structured grid file in binary XML form. This is simple as

```fortran
USE Lib_VTK_IO
...
Expand All @@ -70,4 +129,5 @@ E_IO = VTK_DAT_XML(var_location='node',var_block_action='close')
E_IO = VTK_GEO_XML()
E_IO = VTK_END_XML()
```

Note that all Lib\_VTK\_IO functions return an error code (`E_IO`) that can be used for sophisticated error trapping algorithms.
58 changes: 39 additions & 19 deletions doc/ChangeLog-BeFoR64.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,49 @@
### Version v1.0.2
# Change Log

Stable release. Fully backward compatible, minor bugs fix:
## [Unreleased](https://github.com/szaghi/BeFoR64/tree/HEAD)

+ change encoders from elemental to pure due to the allocation of code;
+ check the dimensions of bits array for not overtake its dimensions;
+ add travis ci support.
[Full Changelog](https://github.com/szaghi/BeFoR64/compare/v1.0.3...HEAD)

### Version v1.0.1
**Closed issues:**

Stable release. Fully backward compatible:
- Pure/Elemental with unlimited polymorphic [\#8](https://github.com/szaghi/BeFoR64/issues/8)

+ add scalar/array encoders for character;
+ add scalar/array decoders for character;
+ add scalar/array encoders for unlimited polymorphic;
+ add scalar/array decoders for unlimited polymorphic.
## [v1.0.3](https://github.com/szaghi/BeFoR64/tree/v1.0.3) (2015-06-08)

### Version v1.0.0
[Full Changelog](https://github.com/szaghi/BeFoR64/compare/v1.0.2...v1.0.3)

Stable release. Fully backward compatible:
**Closed issues:**

+ add scalar encoders for numbers;
+ add scalar/array decoders for numbers;
+ add initializing procedure;
+ add autotest procedure.
- Unlimited polymorphic encoding/decoding [\#5](https://github.com/szaghi/BeFoR64/issues/5)

### Version v0.0.1
- Characters encoding/decoding [\#4](https://github.com/szaghi/BeFoR64/issues/4)

First stable release.
- Wiki Exploiting [\#3](https://github.com/szaghi/BeFoR64/issues/3)

- Documentation improvement [\#2](https://github.com/szaghi/BeFoR64/issues/2)

## [v1.0.2](https://github.com/szaghi/BeFoR64/tree/v1.0.2) (2015-02-12)

[Full Changelog](https://github.com/szaghi/BeFoR64/compare/v1.0.1...v1.0.2)

## [v1.0.1](https://github.com/szaghi/BeFoR64/tree/v1.0.1) (2015-02-03)

[Full Changelog](https://github.com/szaghi/BeFoR64/compare/v1.0.0...v1.0.1)

**Closed issues:**

- Decoders implementing [\#1](https://github.com/szaghi/BeFoR64/issues/1)

## [v1.0.0](https://github.com/szaghi/BeFoR64/tree/v1.0.0) (2015-02-02)

[Full Changelog](https://github.com/szaghi/BeFoR64/compare/v0.1.1...v1.0.0)

## [v0.1.1](https://github.com/szaghi/BeFoR64/tree/v0.1.1) (2015-01-29)

[Full Changelog](https://github.com/szaghi/BeFoR64/compare/v0.0.1...v0.1.1)

## [v0.0.1](https://github.com/szaghi/BeFoR64/tree/v0.0.1) (2015-01-27)



\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
47 changes: 33 additions & 14 deletions doc/README-BeFoR64.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,44 @@

# BeFoR64 [![GitHub tag](https://img.shields.io/github/tag/szaghi/BeFoR64.svg)]()

[![License](https://img.shields.io/badge/license-GNU%20GeneraL%20Public%20License%20v3%20,%20GPLv3-blue.svg)]()
[![License](https://img.shields.io/badge/license-GNU%20GeneraL%20Public%20License%20v3,%20GPLv3-blue.svg)]()
[![License](https://img.shields.io/badge/license-BSD2-red.svg)]()
[![License](https://img.shields.io/badge/license-BSD3-red.svg)]()
[![License](https://img.shields.io/badge/license-MIT-red.svg)]()

[![Status](https://img.shields.io/badge/status-stable-brightgreen.svg)]()
[![Build Status](https://travis-ci.org/szaghi/BeFoR64.svg?branch=master)](https://travis-ci.org/szaghi/BeFoR64)
[![Coverage Status](https://coveralls.io/repos/szaghi/BeFoR64/badge.svg?branch=master)](https://coveralls.io/r/szaghi/BeFoR64?branch=master)
[![Coverage Status](https://img.shields.io/codecov/c/github/szaghi/BeFoR64.svg)](https://img.shields.io/codecov/c/github/szaghi/BeFoR64.svg)

### BeFoR64, Base64 encoding/decoding library for FoRtran poor men
### BeFoR64, Base64 encoding/decoding library for FoRtran poor people

+ BeFoR64 is a pure Fortran (KISS) library for base64 encoding/decoding for modern (2003+) Fortran projects;
+ BeFoR64 is Fortran 2003+ standard compliant;
+ BeFoR64 is a Free, Open Source Project.

#### Table of Contents

- [What is BeFoR64?](#what-is-befor64)
- [Main features](#main-features)
- [Copyrights](#copyrights)
- [Documentation](#documentation)
- [A Taste of BeFoR64](#a-taste-of-befor64)

#### Issues

[![GitHub issues](https://img.shields.io/github/issues/szaghi/BeFoR64.svg)]()
[![Ready in backlog](https://badge.waffle.io/szaghi/BeFoR64.png?label=ready&title=Ready)](https://waffle.io/szaghi/BeFoR64)
[![In Progress](https://badge.waffle.io/szaghi/BeFoR64.png?label=in%20progress&title=In%20Progress)](https://waffle.io/szaghi/BeFoR64)
[![Open bugs](https://badge.waffle.io/szaghi/BeFoR64.png?label=bug&title=Open%20Bugs)](https://waffle.io/szaghi/BeFoR64)

#### Compiler Support
[![Compiler](https://img.shields.io/badge/GNU%20Gfortran%20Compiler-build%20pass%20with%20v4.9.2+-brightgreen.svg)]()

[![Compiler](https://img.shields.io/badge/Intel%20Fortran%20Compiler-build%20pass%20with%20v12.x+-brightgreen.svg)]()

[![Compiler](https://img.shields.io/badge/IBM%20XL%20Fortran%20Compiler-not%20tested-yellow.svg)]()

[![Compiler](https://img.shields.io/badge/g95%20Fortran%20Compiler-not%20tested-yellow.svg)]()

[![Compiler](https://img.shields.io/badge/NAG%20Fortran%20Compiler-not%20tested-yellow.svg)]()

[![Compiler](https://img.shields.io/badge/PGI%20Fortran%20Compiler-not%20tested-yellow.svg)]()
[![Compiler](https://img.shields.io/badge/GNU-pass%20(v4.9.2+)-brightgreen.svg)]()
[![Compiler](https://img.shields.io/badge/Intel-pass%20(v12.x+)-brightgreen.svg)]()
[![Compiler](https://img.shields.io/badge/IBM%20XL-not%20tested-yellow.svg)]()
[![Compiler](https://img.shields.io/badge/g95-not%20tested-yellow.svg)]()
[![Compiler](https://img.shields.io/badge/NAG-not%20tested-yellow.svg)]()
[![Compiler](https://img.shields.io/badge/PGI-not%20tested-yellow.svg)]()

## What is BeFoR64?

Expand Down Expand Up @@ -69,7 +77,18 @@ Go to [Top](#top)

## Copyrights

BeFoR64 is an open source project, it is distributed under the [GPL v3](http://www.gnu.org/licenses/gpl-3.0.html). Anyone is interest to use, to develop or to contribute to BeFoR64 is welcome.
BeFoR64 is an open source project, it is distributed under a multi-licensing system:

+ for FOSS projects:
- [GPL v3](http://www.gnu.org/licenses/gpl-3.0.html);
+ for closed source/commercial projects:
- [BSD 2-Clause](http://opensource.org/licenses/BSD-2-Clause);
- [BSD 3-Clause](http://opensource.org/licenses/BSD-3-Clause);
- [MIT](http://opensource.org/licenses/MIT).

Anyone is interest to use, to develop or to contribute to BeFoR64 is welcome, feel free to select the license that best matches your soul!

More details can be found on [wiki](https://github.com/szaghi/BeFoR64/wiki/Copyrights).

Go to [Top](#top)

Expand Down
Loading

0 comments on commit 44b56be

Please sign in to comment.