=== Getting started with Gnucap ===

== Build and Install ==

Gnucap source code is organised as a main library with plugins developped in numerous git repositories.
Plugins and extensions not shipped with the main "Gnucap" package require a Gnucap
installation for compilation and use. Installation instructions can be found in the [[https://codeberg.org/gnucap/gnucap/src/branch/develop/INSTALL|INSTALL]] file at the top level of the source repository, and in the respective documentation of the extension packages. Beware of out-of-date binary packages distributed elsewhere. When building from source, make sure to match version tags across repositories, or **use the current develop branches**.

== Hello world ==

Gnucap is undergoing developments that add support for Verilog-AMS, towards providing a contemporary approach to circuit simulation. Right now, normal use can involve old stuff, and some of the official [[gnucap:manual:examples]] involve antiquated syntax. To get unstuck, focus on examples involving Verilog features.

== More examples ==

There are input files in the main package that we use for [[https://codeberg.org/gnucap/gnucap/src/branch/develop/tests|testing]]. Older ones, "*.ckt" resemble batch files from the Spice2 era, and may be executed with "gnucap -b". Newer ones, with ".gc" extension can be read directly, i.e. without "-b" flag. Not all tests are instructive or beginner friendly...

In addition to [[https://codeberg.org/gnucap/gnucap-modelgen-verilog/src/branch/develop/tests|tests]], modelgen-verilog has [[https://codeberg.org/gnucap/gnucap-modelgen-verilog/src/branch/develop/examples|examples]] with instructions, too. The [[https://codeberg.org/gnucap/gnucap-modelgen-verilog/src/branch/develop/vams|vams library]] implements example "SPICE primitives" from Annex E in Verilog-AMS.

[[https://codeberg.org/qucs/gui/src/branch/develop/examples|Examples]] from the Qucs project demonstrate data interchange with a schematic editor.

The [[https://codeberg.org/gnucap/gnucap-models|models-repo]] contains example uses of devices with SPICE interface.

There are themed examples in various other repos such as [[https://codeberg.org/gnucap/gnucap-geda/src/branch/develop/examples|here]] and [[https://codeberg.org/gnucap/gnucap-python/src/branch/develop/examples|here]].

== Development ==

The Gnucap project was hosted on savannah [[https://savannah.gnu.org/p/gnucap|savannah]] and is currently undergoing a migration to [[https://codeberg.org/gnucap|codeberg]], which has become the preferred official development platform. Active (and prospective) participants are encouraged to join and follow our chat at ''#gnucap:matrix.org''.

A basic contribution guide can be found in the [[https://codeberg.org/gnucap/gnucap/src/branch/develop/CONTRIBUTE|CONTRIBUTE]]
file in the main repo. Similar files may be found in related repositories.

We advise new contributors to focus on bug triage (testing, reporting, debugging) and to take on projects
[[http://gnucap.org/dokuwiki/doku.php/gnucap:projects|proposed here]], or similar. For work on the core projects,
we offer [[gnucap:onboarding|onboarding help]] on designated simple[r] tasks, as time permits.

Technical notes are in the [[gnucap:manual:tech|manual]] to familiarise yourself with in the process of getting started.