Skip to content

Commit

Permalink
add citing information
Browse files Browse the repository at this point in the history
  • Loading branch information
Datseris committed Nov 21, 2017
1 parent ead839f commit 0e60243
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ The goals of the package is to provide a flexible and intuitive framework for fa
|:--------:|:--------:|:---------------:|:-----:|:-----:|
|[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://JuliaDynamics.github.io/DynamicalBilliards.jl/latest), [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaDynamics.github.io/DynamicalBilliards.jl/stable)| [![status](http://joss.theoj.org/papers/753469f6b18c9c38127a7727d13c87cd/status.svg)](http://joss.theoj.org/papers/753469f6b18c9c38127a7727d13c87cd) | [![Build Status](https://travis-ci.org/JuliaDynamics/DynamicalBilliards.jl.svg?branch=master)](https://travis-ci.org/JuliaDynamics/DynamicalBilliards.jl) | [![Build status](https://ci.appveyor.com/api/projects/status/ksgb8pv5xl0j315y?svg=true)](https://ci.appveyor.com/project/JuliaDynamics/dynamicalbilliards-jl-wt09b) | [![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/JuliaDynamics/Lobby)

If you have used this package for research that resulted in a publication, please be
kind enough to cite the paper associated with DynamicalBilliards.jl. The DOI is
https://doi.org/10.21105/joss.00458 and you can cite as:

>Datseris, (2017). DynamicalBilliards.jl: An easy-to-use, modular and extendable Julia package for Dynamical Billiard systems in two dimensions.. Journal of Open Source Software, 2(19), 458, doi:10.21105/joss.00458
## Features

The core of `DynamicalBilliards.jl` is separated in simple and cohesive modular structures:

Expand Down
9 changes: 9 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ Dynamical Billiard systems in two dimensions.
Checkout the [Julia billiard animation](#julia-billiard-animation)
code to see how to create the animated billiard of our logo.

## Description

A dynamical billiard is a system where a particle is propagating as a straight line from obstacle to obstacle, performing specular reflection at the boundary of the obstacles. Billiard systems have been used extensively in mathematics, nonlinear dynamics and chaos and played an important role in the development of nonlinear science.

The above will be referred to as the "standard" billiard. The [wikipedia page](https://en.wikipedia.org/wiki/Dynamical_billiards) has many examples of different types of billiards. Also, the [scholarpedia](http://www.scholarpedia.org/article/Dynamical_billiards) entry is a good read on the subject. In general, the standard billiard can be extended in many ways.
Expand All @@ -20,6 +22,13 @@ also no support for collision between particles.

---

## Citing
If you have used this package for research that resulted in a publication, please be
kind enough to cite the paper associated with DynamicalBilliards.jl. The DOI is
https://doi.org/10.21105/joss.00458 and you can cite as:

>Datseris, (2017). DynamicalBilliards.jl: An easy-to-use, modular and extendable Julia package for Dynamical Billiard systems in two dimensions.. Journal of Open Source Software, 2(19), 458, doi:10.21105/joss.00458
## Installation

This package is registered, simply use `Pkg.add("DynamicalBilliards")` to install it.
Expand Down

0 comments on commit 0e60243

Please sign in to comment.