Skip to content
Snippets Groups Projects
  • akuesters's avatar
    Python Documentation PR (#687) · fa7ea458
    akuesters authored and Benjamin Cumming's avatar Benjamin Cumming committed
    Update documentation for Python.
    
        splits the conceptual model ideas from the C++ docs into their own section
        has C++ and Python docs for recipes, domain decomposition, etc.
    
    fixes #667
    
    Added the following documentation (structure):
    
    GETTING STARTED:
    
        Installing Arbor/Requirements/Optional Requirements/Python
        Installing Arbor/Building and Installing Arbor/Python Front End
    
    MODEL BASICS:
    
        Overview
        Common Types
        Recipes
        Domain Decomposition
        Simulations
    
    PYTHON:
    
        Overview
        Common Types
        Recipes
        Domain Decomposition
        Simulations
    
    DEVELOPERS:
    
        Python Profiler
        Python Unit Testing
    
    GETTING STARTED has two added sections of optional requirements using python and how to build the python front end.
    
    MODEL BASICS describes Arbor's concepts in general (independent of programming language), thus general information on concepts in C++ API was moved here/ added.
    
    PYTHON describes Arbor's pyth...
    fa7ea458