Welcome to micc’s documentation!

Contents:

• Micc
  • Credits
    • Roadmap
• Installation
  • Debugging micc and micc-build
• Usage
• Applications (CLI)
  • micc
    • add
    • convert-to-package
    • create
    • info
    • mv
    • tag
    • version
• API
  • Package et-micc
  • Module et_micc.project
  • Module et_micc.expand
  • Module et_micc.logger
  • Module et_micc.utils
  • Module et_micc.tomlfile
  • Module et_micc.static_vars
• Development environment
  • Principles
  • Setting up your local Development environment - step by step
  • Setting up your cluster Development environment - step by step
    • Productivity tip
• Frequently asked questions
  • Can I use Anaconda Python distributions?
  • Can I use micc on the (VSC) clusters?
  • Why doesn’t micc have rename and remove commands?
• Tutorials
  • Tutorial 1: Getting started with micc
    • 1.1 Creating a project
    • 1.2 First steps in micc
    • 1.3 Miscellaneous
    • 1.4 A first real project
    • 1.3 Improving efficiency
  • Tutorial 2: Binary extensions
    • 2.1 Binary extensions in Micc projects
    • 2.2 Building binary extensions from Fortran
    • 2.3 Building binary extensions from C++
    • 2.4 Data type issues
    • 2.5 Specifying compiler options for binary extension modules
    • 2.6 Documenting binary extension modules
  • Tutorial 3: Adding Python components
    • 3.1 Adding a Python module
    • 3.2 Adding a Python Command Line Interface
  • Tutorial 4: Version control and version management
    • 4.1 Git support
    • 4.2 Version management
  • Tutorial 5 - Publishing your code
    • 5.1 Publishing to the Python Package Index
    • 5.2 Publishing packages with binary extension modules
    • 5.3 Providing auto_build_binary_extension() with custom build parameters
    • 5.4 Publishing your documentation on readthedocs.org
  • Tutorial 6 - Using micc projects on the VSC clusters
    • 6.1 Using modules
    • 6.2 Using Poetry on the cluster
• Interesting links on Python programming
  • For Beginners
  • Python as a language
  • Software engineering
  • Python internals
  • Python for HPC
  • Code modernization
  • Profiling
  • Resource monitoring
  • Python idioms and readability
  • Useful packages
  • Exceptions
  • Type checking in Python
  • Design patterns
  • Testing
  • Debugging
  • Logging
  • Profiling
  • Scientific Python
  • Machine learning and datascience
  • CLIs
  • Packaging
  • Graphics
  • Installing packages
  • Tools
  • Development environment, developement workflow
  • Problem solving
  • Documentation
  • Django
  • Fortran/C/C++
  • Compilers
  • Notebooks
  • Containers
  • Windows
  • Linux
  • Programming blogs
• Authors
  • Development
• History
  • Using poetry on the cluster
    • v0.10.25
    • v0.9.6 (2019-11-21)
    • v0.9.5 (2019-11-19)
    • v0.8.0 (2019-11-11)
    • v0.7.5 (2019-11-11)
    • v0.7.4 (2019-10-23)
    • v0.7.3 (2019-10-22)
    • v0.7.2 (2019-10-22)
    • v0.7.1 (2019-10-21)
    • v0.7.0 (2019-10-18)
    • v0.6.8 (2019-10-17)
    • v0.6.6 (2019-10-10)
    • v0.6.5 (2019-10-08)
    • v0.6.4 (2019-10-05)
    • v0.6.3 (2019-10-04)
    • v0.6.2 (2019-10-02)
    • v0.6.1 (2019-09-27)
    • v0.6.0 (2019-09-27)
    • v0.5.17 (2019-09-26)
    • v0.5.16 (2019-09-25)
    • v0.5.15 (2019-09-25)
    • v0.5.14 (2019-09-25)
    • v0.5.13 (2019-09-23)
    • v0.5.12 (2019-09-19)
    • v0.5.11 (2019-09-18)
    • v0.5.10 (2019-09-09)
    • v0.5.9 (2019-09-06)
    • v0.5.8 (2019-09-06)
    • v0.5.7 (2019-09-06)
    • v0.5.6 (2019-07-19)
    • v0.5.5 (2019-07-19)
    • v0.5.4 (2019-07-10)
    • v0.5.3 (2019-07-09)
    • v0.5.2 (2019-07-09)
    • v0.5.1 (2019-07-09)
    • v0.5.0 (2019-07-04)
    • v0.4.0 (2019-06-11)
    • v0.2.5 (2019-06-11)
    • v0.2.4 (2019-06-11)
    • v0.2.3 (2019-06-11)
    • v0.1.21 (2019-06-11)
    • v0.0.0 (2019-06-06)
    • Open Issues
  • #24 [feature] add indentation to logging
  • #22 [issue] building cpp module fails when pybind11 is pip-installed
  • #5 [feature] packaging and deployment, and the use of poetry in general
  • issue #8 cookiecutter.json files
    • Closed Issues
  • #1 [bug] FileExistsError in micc module
  • #3 [feature] add useful example code to templates
  • #4 [bug] build commands for f2py and cpp modules
  • feature #11 add log files to micc build
  • issue #9 prohibit creation of a micc project under another project
  • issue #7 cookiecutter.json files are temporary
  • #2 [feature] simple python project
  • issue #12 common items in micc.json files
  • #13 [feature] os.path -> pathlib
  • #14 [feature] add flag for nesting a project inside another project
  • #6 [feature] decomposition
  • issue #10 micc files are part of the template
  • #16 [issue] poetry 1.0.0b1 uses different cleo than 0.12.17
  • #15 [issue] using poetry bumping the version in pyproject.toml
  • #19 [issue] avoiding poetry
  • #21 [issue] micc create
  • #20 [issue] install dependencies in current conda environment
  • #18 [issue] two tools for reading/writing toml files
  • #17 [issue] poetry 1.0.0b1 does not play well with conda
  • #23 [issue] remove interactivity from micc app and micc module
    • TODO
  • Poetry considerations
  • Development plan
  • Think big, start small…

Indices and tables

• Index
• Module Index
• Search Page