2024-04-19 16:53:24 +02:00
|
|
|
####################
|
|
|
|
|
# - Project Config
|
|
|
|
|
####################
|
feat: Working logging, before- and after-deps.
We have a far more sane approach to nodeps now, which
allows us to essentially have two loggers - one that is
very useful, pretty, and clear, but requires a 'rich'
dependency, and one that is simple.
In this spirit, we factored out services/ too.
We can also set the initial console log level now when
packing the .zip.
There's still work to do with the actual flow for deps
installing / uninstalling.
But it should be far more robust now.
Finally, we have a barebones working `quartodoc`-based docs site.
It's super clever; see <https://github.com/machow/quartodoc>.
As it's "just" a quarto project with some python autodiscovery,
fleshing it out with ex. math, images, diagrams, and so forth
should be exceptionally easy.
As we develop, various linter-guided fixes are being realized.
This will be a long process, best done as we spiff everything up
in preparation for general release.
2024-03-21 18:45:38 +01:00
|
|
|
project:
|
|
|
|
|
type: website
|
2024-04-19 16:53:24 +02:00
|
|
|
output-dir: _site
|
|
|
|
|
|
|
|
|
|
format:
|
|
|
|
|
html:
|
|
|
|
|
toc: true
|
|
|
|
|
|
|
|
|
|
filters:
|
|
|
|
|
- interlinks
|
|
|
|
|
|
|
|
|
|
interlinks:
|
|
|
|
|
sources:
|
|
|
|
|
numpy:
|
|
|
|
|
url: https://numpy.org/doc/stable/
|
|
|
|
|
matplotlib:
|
|
|
|
|
url: https://matplotlib.org/stable/
|
|
|
|
|
python:
|
|
|
|
|
url: https://docs.python.org/3/
|
|
|
|
|
|
|
|
|
|
metadata-files:
|
|
|
|
|
# Sidebar for /pydocs Paths
|
|
|
|
|
- pydocs/_sidebar.yml
|
feat: Working logging, before- and after-deps.
We have a far more sane approach to nodeps now, which
allows us to essentially have two loggers - one that is
very useful, pretty, and clear, but requires a 'rich'
dependency, and one that is simple.
In this spirit, we factored out services/ too.
We can also set the initial console log level now when
packing the .zip.
There's still work to do with the actual flow for deps
installing / uninstalling.
But it should be far more robust now.
Finally, we have a barebones working `quartodoc`-based docs site.
It's super clever; see <https://github.com/machow/quartodoc>.
As it's "just" a quarto project with some python autodiscovery,
fleshing it out with ex. math, images, diagrams, and so forth
should be exceptionally easy.
As we develop, various linter-guided fixes are being realized.
This will be a long process, best done as we spiff everything up
in preparation for general release.
2024-03-21 18:45:38 +01:00
|
|
|
|
2024-04-19 16:53:24 +02:00
|
|
|
####################
|
|
|
|
|
# - Website Config
|
|
|
|
|
####################
|
2024-04-08 08:37:42 +02:00
|
|
|
website:
|
2024-04-19 16:53:24 +02:00
|
|
|
title: "Blender Maxwell"
|
|
|
|
|
description: "A Blender-based design and analysis tool for electromagnetic simulations"
|
2024-04-08 08:37:42 +02:00
|
|
|
page-footer: "Copyright 2024, Sofus Albert Høgsbro Rose"
|
2024-04-19 16:53:24 +02:00
|
|
|
repo-url: https://github.com/so-rose/blender_maxwell/
|
|
|
|
|
repo-actions: [issue]
|
|
|
|
|
page-navigation: true
|
2024-04-08 08:37:42 +02:00
|
|
|
navbar:
|
2024-04-19 16:53:24 +02:00
|
|
|
background: primary
|
|
|
|
|
pinned: true
|
|
|
|
|
search: true
|
2024-04-08 08:37:42 +02:00
|
|
|
left:
|
|
|
|
|
- file: index.qmd
|
|
|
|
|
text: Home
|
|
|
|
|
- file: pydocs/index.qmd
|
|
|
|
|
text: Reference
|
|
|
|
|
tools:
|
|
|
|
|
- icon: github
|
|
|
|
|
menu:
|
|
|
|
|
- text: Source Code
|
|
|
|
|
url: https://github.com/so-rose/blender_maxwell/
|
|
|
|
|
- text: Report a Bug
|
|
|
|
|
url: https://github.com/so-rose/blender_maxwell/issues/new/choose
|
|
|
|
|
|
|
|
|
|
####################
|
2024-04-19 16:53:24 +02:00
|
|
|
# - Quartodoc Config
|
2024-04-08 08:37:42 +02:00
|
|
|
####################
|
feat: Working logging, before- and after-deps.
We have a far more sane approach to nodeps now, which
allows us to essentially have two loggers - one that is
very useful, pretty, and clear, but requires a 'rich'
dependency, and one that is simple.
In this spirit, we factored out services/ too.
We can also set the initial console log level now when
packing the .zip.
There's still work to do with the actual flow for deps
installing / uninstalling.
But it should be far more robust now.
Finally, we have a barebones working `quartodoc`-based docs site.
It's super clever; see <https://github.com/machow/quartodoc>.
As it's "just" a quarto project with some python autodiscovery,
fleshing it out with ex. math, images, diagrams, and so forth
should be exceptionally easy.
As we develop, various linter-guided fixes are being realized.
This will be a long process, best done as we spiff everything up
in preparation for general release.
2024-03-21 18:45:38 +01:00
|
|
|
quartodoc:
|
2024-04-08 08:37:42 +02:00
|
|
|
# Output
|
|
|
|
|
dir: pydocs
|
|
|
|
|
sidebar: pydocs/_sidebar.yml
|
|
|
|
|
|
feat: Working logging, before- and after-deps.
We have a far more sane approach to nodeps now, which
allows us to essentially have two loggers - one that is
very useful, pretty, and clear, but requires a 'rich'
dependency, and one that is simple.
In this spirit, we factored out services/ too.
We can also set the initial console log level now when
packing the .zip.
There's still work to do with the actual flow for deps
installing / uninstalling.
But it should be far more robust now.
Finally, we have a barebones working `quartodoc`-based docs site.
It's super clever; see <https://github.com/machow/quartodoc>.
As it's "just" a quarto project with some python autodiscovery,
fleshing it out with ex. math, images, diagrams, and so forth
should be exceptionally easy.
As we develop, various linter-guided fixes are being realized.
This will be a long process, best done as we spiff everything up
in preparation for general release.
2024-03-21 18:45:38 +01:00
|
|
|
# Python Package
|
|
|
|
|
source_dir: ../src
|
|
|
|
|
package: blender_maxwell
|
|
|
|
|
parser: google
|
|
|
|
|
|
|
|
|
|
# Style
|
|
|
|
|
style: pkgdown
|
2024-04-08 08:37:42 +02:00
|
|
|
title: "Blender Maxwell"
|
feat: Working logging, before- and after-deps.
We have a far more sane approach to nodeps now, which
allows us to essentially have two loggers - one that is
very useful, pretty, and clear, but requires a 'rich'
dependency, and one that is simple.
In this spirit, we factored out services/ too.
We can also set the initial console log level now when
packing the .zip.
There's still work to do with the actual flow for deps
installing / uninstalling.
But it should be far more robust now.
Finally, we have a barebones working `quartodoc`-based docs site.
It's super clever; see <https://github.com/machow/quartodoc>.
As it's "just" a quarto project with some python autodiscovery,
fleshing it out with ex. math, images, diagrams, and so forth
should be exceptionally easy.
As we develop, various linter-guided fixes are being realized.
This will be a long process, best done as we spiff everything up
in preparation for general release.
2024-03-21 18:45:38 +01:00
|
|
|
|
2024-04-08 08:37:42 +02:00
|
|
|
# Options
|
2024-04-19 16:53:24 +02:00
|
|
|
renderer:
|
|
|
|
|
style: markdown
|
|
|
|
|
#show_signature: true
|
|
|
|
|
show_signature_annotations: false
|
|
|
|
|
display_name: name
|
2024-04-08 08:37:42 +02:00
|
|
|
options:
|
2024-04-19 16:53:24 +02:00
|
|
|
#include_private: true
|
2024-04-08 08:37:42 +02:00
|
|
|
include_empty: true
|
|
|
|
|
include_attributes: true
|
|
|
|
|
signature_name: "short"
|
feat: Working logging, before- and after-deps.
We have a far more sane approach to nodeps now, which
allows us to essentially have two loggers - one that is
very useful, pretty, and clear, but requires a 'rich'
dependency, and one that is simple.
In this spirit, we factored out services/ too.
We can also set the initial console log level now when
packing the .zip.
There's still work to do with the actual flow for deps
installing / uninstalling.
But it should be far more robust now.
Finally, we have a barebones working `quartodoc`-based docs site.
It's super clever; see <https://github.com/machow/quartodoc>.
As it's "just" a quarto project with some python autodiscovery,
fleshing it out with ex. math, images, diagrams, and so forth
should be exceptionally easy.
As we develop, various linter-guided fixes are being realized.
This will be a long process, best done as we spiff everything up
in preparation for general release.
2024-03-21 18:45:38 +01:00
|
|
|
|
|
|
|
|
sections:
|
2024-04-15 15:12:29 +02:00
|
|
|
####################
|
|
|
|
|
# - scripts
|
|
|
|
|
####################
|
2024-04-08 08:37:42 +02:00
|
|
|
- title: "`scripts`"
|
|
|
|
|
desc: Build/packaging scripts for developing and publishing the addon.
|
|
|
|
|
package: scripts
|
feat: Working logging, before- and after-deps.
We have a far more sane approach to nodeps now, which
allows us to essentially have two loggers - one that is
very useful, pretty, and clear, but requires a 'rich'
dependency, and one that is simple.
In this spirit, we factored out services/ too.
We can also set the initial console log level now when
packing the .zip.
There's still work to do with the actual flow for deps
installing / uninstalling.
But it should be far more robust now.
Finally, we have a barebones working `quartodoc`-based docs site.
It's super clever; see <https://github.com/machow/quartodoc>.
As it's "just" a quarto project with some python autodiscovery,
fleshing it out with ex. math, images, diagrams, and so forth
should be exceptionally easy.
As we develop, various linter-guided fixes are being realized.
This will be a long process, best done as we spiff everything up
in preparation for general release.
2024-03-21 18:45:38 +01:00
|
|
|
contents:
|
2024-04-19 16:53:24 +02:00
|
|
|
- info
|
|
|
|
|
- pack
|
|
|
|
|
- dev
|
|
|
|
|
- bl_delete_addon
|
|
|
|
|
- bl_install_addon
|
feat: Working logging, before- and after-deps.
We have a far more sane approach to nodeps now, which
allows us to essentially have two loggers - one that is
very useful, pretty, and clear, but requires a 'rich'
dependency, and one that is simple.
In this spirit, we factored out services/ too.
We can also set the initial console log level now when
packing the .zip.
There's still work to do with the actual flow for deps
installing / uninstalling.
But it should be far more robust now.
Finally, we have a barebones working `quartodoc`-based docs site.
It's super clever; see <https://github.com/machow/quartodoc>.
As it's "just" a quarto project with some python autodiscovery,
fleshing it out with ex. math, images, diagrams, and so forth
should be exceptionally easy.
As we develop, various linter-guided fixes are being realized.
This will be a long process, best done as we spiff everything up
in preparation for general release.
2024-03-21 18:45:38 +01:00
|
|
|
|
2024-04-15 15:12:29 +02:00
|
|
|
####################
|
|
|
|
|
# - bl_maxwell
|
|
|
|
|
####################
|
2024-04-08 08:37:42 +02:00
|
|
|
- title: "`bl_maxwell`"
|
|
|
|
|
desc: Root package for the addon.
|
|
|
|
|
contents:
|
2024-04-19 16:53:24 +02:00
|
|
|
- preferences
|
|
|
|
|
- registration
|
2024-04-08 08:37:42 +02:00
|
|
|
|
|
|
|
|
- subtitle: "`bl_maxwell.assets`"
|
|
|
|
|
desc: Blender assets bundled w/Blender Maxwell
|
|
|
|
|
contents:
|
2024-04-19 16:53:24 +02:00
|
|
|
- assets
|
2024-04-27 15:55:15 +02:00
|
|
|
- assets.geonodes
|
2024-04-08 08:37:42 +02:00
|
|
|
|
|
|
|
|
- subtitle: "`bl_maxwell.nodeps`"
|
|
|
|
|
desc: No-Dependency
|
|
|
|
|
contents:
|
2024-04-19 16:53:24 +02:00
|
|
|
- operators
|
2024-04-08 08:37:42 +02:00
|
|
|
|
|
|
|
|
- subtitle: "`bl_maxwell.utils`"
|
|
|
|
|
desc: Utilities wo/shared global state.
|
|
|
|
|
contents:
|
2024-04-19 16:53:24 +02:00
|
|
|
- utils.blender_type_enum
|
|
|
|
|
- utils.extra_sympy_units
|
|
|
|
|
- utils.logger
|
2024-04-08 08:37:42 +02:00
|
|
|
|
|
|
|
|
- subtitle: "`bl_maxwell.services`"
|
|
|
|
|
desc: Utilities w/shared global state.
|
|
|
|
|
contents:
|
2024-04-19 16:53:24 +02:00
|
|
|
- services.tdcloud
|
2024-04-08 08:37:42 +02:00
|
|
|
|
|
|
|
|
- subtitle: "`bl_maxwell.operators`"
|
|
|
|
|
desc: General Blender operators.
|
|
|
|
|
contents:
|
2024-04-19 16:53:24 +02:00
|
|
|
- operators.bl_append
|
|
|
|
|
- operators.connect_viewer
|
2024-04-08 08:37:42 +02:00
|
|
|
|
2024-04-15 15:12:29 +02:00
|
|
|
####################
|
|
|
|
|
# - ..maxwell_sim_nodes
|
|
|
|
|
####################
|
2024-04-08 08:37:42 +02:00
|
|
|
- title: "`..maxwell_sim_nodes`"
|
|
|
|
|
desc: Maxwell Simulation Design/Viz Node Tree.
|
|
|
|
|
package: blender_maxwell.node_trees.maxwell_sim_nodes
|
|
|
|
|
contents:
|
2024-04-19 16:53:24 +02:00
|
|
|
- bl_socket_map
|
|
|
|
|
- categories
|
|
|
|
|
- bl_cache
|
|
|
|
|
- node_tree
|
2024-04-08 08:37:42 +02:00
|
|
|
|
|
|
|
|
- subtitle: "`contracts`"
|
|
|
|
|
desc: Constants and interfaces for identifying resources.
|
|
|
|
|
package: blender_maxwell.node_trees.maxwell_sim_nodes.contracts
|
|
|
|
|
contents:
|
|
|
|
|
# General
|
2024-04-19 16:53:24 +02:00
|
|
|
- flow_kinds
|
|
|
|
|
- flow_kinds.FlowKind
|
|
|
|
|
- flow_kinds.LazyValueFuncFlow
|
|
|
|
|
- icons
|
2024-04-08 08:37:42 +02:00
|
|
|
|
2024-04-19 16:53:24 +02:00
|
|
|
- tree_types
|
2024-04-08 08:37:42 +02:00
|
|
|
|
|
|
|
|
# Managed Objects
|
2024-04-19 16:53:24 +02:00
|
|
|
- mobj_types
|
2024-04-08 08:37:42 +02:00
|
|
|
|
|
|
|
|
# Nodes
|
2024-04-19 16:53:24 +02:00
|
|
|
- node_types
|
|
|
|
|
- category_types
|
|
|
|
|
- category_labels
|
2024-04-08 08:37:42 +02:00
|
|
|
|
|
|
|
|
# Sockets
|
2024-04-19 16:53:24 +02:00
|
|
|
- socket_types
|
|
|
|
|
- socket_colors
|
|
|
|
|
- bl_socket_types
|
|
|
|
|
- bl_socket_desc_map
|
|
|
|
|
|
|
|
|
|
- unit_systems
|
2024-04-08 08:37:42 +02:00
|
|
|
|
|
|
|
|
- subtitle: "`managed_objs`"
|
|
|
|
|
desc: Maxwell Simulation Design/Viz Node Tree
|
|
|
|
|
package: blender_maxwell.node_trees.maxwell_sim_nodes.managed_objs
|
|
|
|
|
contents:
|
2024-04-19 16:53:24 +02:00
|
|
|
- managed_bl_collection
|
|
|
|
|
- managed_bl_empty
|
|
|
|
|
- managed_bl_image
|
|
|
|
|
- managed_bl_mesh
|
|
|
|
|
- managed_bl_modifier
|
2024-04-15 15:12:29 +02:00
|
|
|
|
|
|
|
|
####################
|
|
|
|
|
# - ..maxwell_sim_nodes.nodes
|
|
|
|
|
####################
|
|
|
|
|
- title: "`...sockets`"
|
|
|
|
|
desc: Maxwell Simulation Node Sockets
|
|
|
|
|
package: blender_maxwell.node_trees.maxwell_sim_nodes.sockets
|
|
|
|
|
contents:
|
2024-04-19 16:53:24 +02:00
|
|
|
- base
|
|
|
|
|
- scan_socket_defs
|
2024-04-15 15:12:29 +02:00
|
|
|
|
|
|
|
|
####################
|
|
|
|
|
# - ..maxwell_sim_nodes.nodes
|
|
|
|
|
####################
|
|
|
|
|
- title: "`...nodes`"
|
|
|
|
|
desc: Maxwell Simulation Nodes
|
|
|
|
|
package: blender_maxwell.node_trees.maxwell_sim_nodes.nodes
|
|
|
|
|
contents:
|
2024-04-19 16:53:24 +02:00
|
|
|
- base
|
|
|
|
|
- events
|
