Skip to content

Commit

Permalink
Merge branch 'release-0.2.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
martinholters committed Jan 4, 2017
2 parents ac5e269 + 6d05cac commit b8ead02
Show file tree
Hide file tree
Showing 23 changed files with 1,070 additions and 758 deletions.
1 change: 1 addition & 0 deletions .codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
comment: false
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/build
5 changes: 3 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
language: julia
julia:
- release
- 0.4
- 0.5
- nightly
- 0.3
notifications:
email: false
webhooks:
Expand All @@ -13,3 +13,4 @@ notifications:
on_start: never
after_success:
- julia -e 'cd(Pkg.dir("ACME")); Pkg.add("Coverage"); using Coverage; Codecov.submit(process_folder()); Coveralls.submit(process_folder())'
- julia -e 'Pkg.add("Documenter", v"0.8.10", v"0.8.10+"); cd(Pkg.dir("ACME")); include(joinpath("docs", "make.jl"))'
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# ACME.jl - Analog Circuit Modeling and Emulation for Julia

[![Join the chat at https://gitter.im/HSU-ANT/ACME.jl](https://badges.gitter.im/HSU-ANT/ACME.jl.svg)](https://gitter.im/HSU-ANT/ACME.jl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Documentation Status](https://readthedocs.org/projects/acmejl/badge/?version=stable)](http://acmejl.readthedocs.io/en/stable/?badge=stable)
[![Documentation](https://img.shields.io/badge/docs-v0.2.0-blue.svg)](https://hsu-ant.github.io/ACME.jl/v0.2.0)

ACME is a [Julia](http://julialang.org/) package for the simulation of
electrical circuits, focusing on audio effect circuits. It allows to
Expand All @@ -17,8 +17,10 @@ Schematics"](http://www.eurasip.org/Proceedings/Eusipco/Eusipco2015/papers/15701
## Installation

If you have not done so already, [download and install
Julia](http://julialang.org/downloads/). (Any version starting with 0.3 should
be fine.)
Julia](http://julialang.org/downloads/). (Any version starting with 0.4 should
be fine; [earlier ACME
versions](https://github.com/HSU-ANT/ACME.jl/tree/v0.1.1) also support Julia
0.3.)

To install ACME, start Julia and run:

Expand Down Expand Up @@ -121,7 +123,8 @@ fail to run altogether.

## Moving on

There is some [documentation](http://acmejl.readthedocs.io) available for how
There is some [documentation](https://hsu-ant.github.io/ACME.jl/v0.2.0)
available for how
to use ACME. Additionally, you can take a look at the examples that can be found
in the `examples` directory below `Pkg.dir("ACME")`.

Expand Down
4 changes: 2 additions & 2 deletions REQUIRE
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
julia 0.3
Compat 0.7.15
julia 0.4
Compat 0.9.0
ProgressMeter 0.2.1
201 changes: 0 additions & 201 deletions doc/elements.rst

This file was deleted.

96 changes: 0 additions & 96 deletions doc/gettingstarted.rst

This file was deleted.

30 changes: 2 additions & 28 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,31 +1,5 @@
ACME.jl - Analog Circuit Modeling and Emulation for Julia
=========================================================

ACME is a Julia_ package for the simulation of electrical circuits, focusing on
audio effect circuits. It allows to programmatically describe a circuit in terms
of elements and connections between them and then automatically derive a model
for the circuit. The model can then be run on varying input data.

ACME is based on the method described in `M. Holters, U. Zölzer, "A Generalized
Method for the Derivation of Non-Linear State-Space Models from Circuit
Schematics"
<http://www.eurasip.org/Proceedings/Eusipco/Eusipco2015/papers/1570103545.pdf>`_.

.. _Julia: http://julialang.org/

Contents:

.. toctree::
:maxdepth: 2

gettingstarted
ug
elements


.. Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
The ACME documentation has moved. Please see `the new ACME documentation site
<https://hsu-ant.github.io/ACME.jl/latest/>`_.
Loading

0 comments on commit b8ead02

Please sign in to comment.