Unverified Commit 8f846920 authored by Stephan Kuschel's avatar Stephan Kuschel Committed by GitHub
Browse files

Merge pull request #259 from skuschel/dev

* replace Travis badge by github action badge
* add script to create/update gh-pages branch
parents 043698db 7c098852
postpic
=======
[![Build Status](https://travis-ci.org/skuschel/postpic.svg?branch=master)](https://travis-ci.org/skuschel/postpic)
[![run-tests](https://github.com/skuschel/postpic/workflows/run-tests/badge.svg)](https://github.com/skuschel/postpic/actions?query=workflow%3Arun-tests)
[![PyPI version](https://badge.fury.io/py/postpic.png)](http://badge.fury.io/py/postpic)
[![Documentation Status](https://readthedocs.org/projects/postpic/badge/?version=latest)](https://postpic.readthedocs.org/)
Postpic is an open-source post-processor for Particle-in-cell (PIC) simulations written in python. If you are doing PIC Simulations (likely for you PhD in physics...) you need tools to provide proper post-processing to create nice graphics from many GB of raw simulation output data -- regardless of what simulation code you are using.
**For working examples, please go to https://github.com/skuschel/postpic-examples**
The (technical, but complete) documentation is hosted on
https://postpic.readthedocs.io/en/latest/
https://skuschel.github.io/postpic/
Idea of postpic
......
#!/bin/bash
#
# This file is part of postpic.
#
# postpic is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# postpic is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with postpic. If not, see <http://www.gnu.org/licenses/>.
#
# Copyright Stephan Kuschel, 2020
# This script creates the documentation as html and saves it to the
# "gh-pages" branch.
set -eux
# ensure Working Directory is clean
git diff-index --quiet HEAD
if ! git rev-parse --verify --quiet gh-pages; then
current_branch=$(git branch --show-current)
echo 'create empty and orphan gh-pages branch'
git checkout --orphan gh-pages
git reset
git commit --allow-empty --no-verify -m "init empty gh-pages branch"
git checkout -f $current_branch
fi
# assert that Working Directory is still clean
git diff-index --quiet HEAD
SHA=$(git rev-parse --verify HEAD)
# create documentation on gh-pages branch
rm -rf doc/build/html
git worktree add -f doc/build/html gh-pages
cd doc
make html
cd build/html
touch .nojekyll
git add .
git commit -a --no-verify -m "postpic documentation at $SHA"
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment