Skip to content

QEP: Refresh Qucs documentation

Jump to bottom Edit New page
guitorri edited this page Dec 23, 2014 · 11 revisions

QEP: Refresh Qucs documentation

Author: Guilherme Brondani Torri
Status: draft
Created: 23th December 2014

Aim

Documentation and translation is very important to help users and turn users into contributors. These should be easy to manage and easy to publish in various formats. A good text about documentation can be found here http://docs.writethedocs.org/.

Most of the Qucs documentation is written in LaTex (qucs-doc) and HTML (qucs-help). The aim is to gradually move all the documents to the reStructuredText markup and the Sphinx documentation generator.

A few advantages are the following:

  • ease the contributions to the documentation;
  • manageable localization (translation) for the documents;
    • PO files and/or translation services such as Transifex
  • generation of HTML, PDF, LaTex, epub... formats;
  • enable the roles of authors and translators;

Thinks to keep in mind

  • The current LaTex documentation need to be converted to reStructuredText.
  • The Po4a converter might be the entry point followed by Pandoc transformations.
  • It should be possible to generate PDF for each chapters as well as the whole book.
  • Keep the list of AUTHORS, TRANSLATORS

Current Status

Based on the existing documentation (qucs-help and qucs-doc) the following classification is proposed.

  • qucs-help : online help (in progress, see below)
  • workbook : tutorials, application notes
  • reportbook : reports on particular components, extensions, test/verification reports
  • technical : related to the simulator, general technical information not particular to program implementation.
  • qucs-dev-manual : guide for contributors to the project

qucs-help

  • info
    • 11 sections
    • reSt (sphinx)
  • audience
    • This manual is intended for general users, beginners and advanced. Beginners shall find basic information about usability, features, components, import/export. Advanced users may find it useful as a quick reference or to learn alternative ways of handling Qucs.
  • sections (http://guitorri.github.io/qucs-help.github.io/html-en/index.html)
    • Getting Started with Analog Simulations
    • Getting Started with Digital Simulations
    • Getting Started with Optimization
    • Getting Started with Octave Scripts
    • Short Description of Actions
    • Working with Subcircuits
    • Short Description of Mathematical Functions
    • List of Special Characters
    • Matching Circuits
    • Installed Files
    • Schematic File Format
  • other

workbook

  • info
    • 20 sections, 573 pages
    • latex
    • done
  • audience
    • Beginners to advanced users looking for recommended ways of using the tools. Each section is self contained in the form of a tutorial or application note.
  • sections
    • Introduction
    • General Design Flow
    • Getting started with Qucs
    • Understanding RF Data Sheet Parameters
    • DC Analysis, Parameter Sweep and Device Models
    • Getting Started with Digital Circuit Simulation
    • Transient Domain Flip-Flop Models for Mixed-Mode Simulation
    • Modelling Operational Amplifiers
    • Modelling the 555 Timer
    • Qucs Simulation of SPICE Netlists
    • Biasing a BJT Transistor
    • BJT Modeling and Verification
    • Power Amplifier Design
    • Low Noise Amplifier Design
    • Microstrip Design
    • Measurement Expressions Reference Manual
    • Component, compact device and circuit modelling using symbolic equations
    • Subcircuit and Verilog-A RF Circuit Simulation Models for Axial and Surface Mounted Resistors
    • Using Qucs in Textmode
  • extra
    • PV Cell simulation with QUCS - A generic model of PV Cell: Photovoltaic_Cell_Model_Miguel Pareja.pdf

reportbook

  • info
    • 14 sections, 263 pages
    • latex
  • audience
    • This manual is intended for users and contributors looking for details about nontrivial features, extensions and test/verification reports.
  • sections
    • Verilog-AMS interface
    • Verilog-A Modular Macromodel for Operational Amplifiers
    • Verilog-A Logarithmic Amplifier Macromodel
    • Verilog-A Macromodel for Resistive Potentiometers
    • Verilog-A compact device models for GaAs MESFETs
    • Verilog-A implementation of the EKV v2.6 long and short channel MOSFET models
    • Compact Verilog-A pn junction photodiode model
    • SPICE to Qucs conversion: Test File 1
    • SPICE to Qucs conversion: Test File 2
    • SPICE to Qucs conversion: Test File 3
    • SPICE to Qucs conversion: Test File 4
    • SPICE to Qucs conversion: Test File 5
    • A Curtice level 1 MESFET model
  • extra
    • Notes on Constructing Qucs Verilog-A Compact Device Models and Circuit Macromodels: Qucs_Verilog_ANotes.pdf

technical

  • info
    • 16 sections, 264 pages
    • latex
  • audience
    • This manual is intended as the technical documentation for the simulator. The descriptions are not directly related to the programming of the simulator itself and approach the problems in a pragmatically way.
  • sections
    • Scattering parameters
    • Noise Waves
    • DC Analysis
    • AC Analysis
    • AC Noise Analysis
    • Transient Analysis
    • Harmonic Balance Analysis
    • Harmonic Balance Noise Analysis
    • Linear devices
    • Non-linear devices
    • Microstrip components
    • Coplanar components
    • Other types of transmission lines
    • Synthesizing circuits
    • Mathematical background
    • Bibliography

dev-manual

  • info
    • TODO
    • reSt (Sphinx)
  • audience
    • This manual is indented for developers whishing to contribute to the QUCS project. It cover aspects of the custom development and workflow.
  • sections
    • Introduction
    • Prerequisites
      • Qt, flex, bison, ADMS, ...
    • Source code structure
    • Qucs suite
      • Qucs
      • filter
      • activefilter
      • attenuator
      • transcalc
      • rescodes
      • help
      • Qucsator
      • Qucsconv
    • Documentation
      • Code documentation Doxygen
      • code style
    • UI Translation
      • Qt Linguist
    • Programing style
    • GUI aspects
      • UI
      • OO
    • Simulator aspects
      • Solver templates
    • File Formats and Parsers
      • netlist
      • schematic
      • input / output
    • Component development
      • static
      • dynamic
    • APIs
      • interfaces
    • Maintenance
      • Git repositories
      • Git Worfklow
      • Build
      • Debug
      • continuous integration
      • unit test
      • qucs-test
    • Website

[ Home | Development | Examples ]

Qucs Project

Development

Examples

Clone this wiki locally