docs: Added README.md and LICENSE
parent
5be3e20e99
commit
e6e7b88959
|
|
@ -0,0 +1,11 @@
|
||||||
|
[*]
|
||||||
|
end_of_line = lf
|
||||||
|
insert_final_newline = true
|
||||||
|
charset = utf-8
|
||||||
|
|
||||||
|
indent_style = tab
|
||||||
|
indent_size = 4
|
||||||
|
trim_trailing_whitespace = false
|
||||||
|
|
||||||
|
[*.yml]
|
||||||
|
indent_style = space
|
||||||
|
|
@ -0,0 +1,39 @@
|
||||||
|
# Binary
|
||||||
|
*.pdf filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.odt filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.doc filter=lfs diff=lfs merge=lfs -text
|
||||||
|
|
||||||
|
# Image
|
||||||
|
*.jpg filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.jpeg filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.png filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.gif filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.psd filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.ai filter=lfs diff=lfs merge=lfs -text
|
||||||
|
|
||||||
|
*.exr filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.tga filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.aif filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.ttf filter=lfs diff=lfs merge=lfs -text
|
||||||
|
|
||||||
|
# Audio
|
||||||
|
*.mp3 filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.wav filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.ogg filter=lfs diff=lfs merge=lfs -text
|
||||||
|
|
||||||
|
# Video
|
||||||
|
*.mp4 filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.mov filter=lfs diff=lfs merge=lfs -text
|
||||||
|
|
||||||
|
# 3D Object
|
||||||
|
*.fbx filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.blend filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.obj filter=lfs diff=lfs merge=lfs -text
|
||||||
|
|
||||||
|
# Library
|
||||||
|
*.dll filter=lfs diff=lfs merge=lfs -text
|
||||||
|
|
||||||
|
# Archive
|
||||||
|
*.a filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.zip filter=lfs diff=lfs merge=lfs -text
|
||||||
|
*.mat filter=lfs diff=lfs merge=lfs -text
|
||||||
|
|
@ -0,0 +1,305 @@
|
||||||
|
####################
|
||||||
|
# - Standard Ignores
|
||||||
|
####################
|
||||||
|
dev
|
||||||
|
.cached-dependencies
|
||||||
|
__pycache__
|
||||||
|
*.blend1
|
||||||
|
*.blend2
|
||||||
|
*.blend3
|
||||||
|
|
||||||
|
|
||||||
|
####################
|
||||||
|
# - LaTeX Ignores (https://github.com/github/gitignore/blob/master/TeX.gitignore)
|
||||||
|
####################
|
||||||
|
|
||||||
|
## Output Ignores
|
||||||
|
notes_[1-9].pdf
|
||||||
|
proj_[1-9].pdf
|
||||||
|
hw_[1-9].pdf
|
||||||
|
|
||||||
|
notes_[1-9][1-9].pdf
|
||||||
|
proj_[1-9][1-9].pdf
|
||||||
|
hw_[1-9][1-9].pdf
|
||||||
|
|
||||||
|
## Core latex/pdflatex auxiliary files:
|
||||||
|
*.aux
|
||||||
|
*.lof
|
||||||
|
*.log
|
||||||
|
*.lot
|
||||||
|
*.fls
|
||||||
|
*.out
|
||||||
|
*.toc
|
||||||
|
*.fmt
|
||||||
|
*.fot
|
||||||
|
*.cb
|
||||||
|
*.cb2
|
||||||
|
.*.lb
|
||||||
|
|
||||||
|
## Intermediate documents:
|
||||||
|
*.dvi
|
||||||
|
*.xdv
|
||||||
|
*-converted-to.*
|
||||||
|
|
||||||
|
## Generated if empty string is given at "Please type another file name for output:"
|
||||||
|
.pdf
|
||||||
|
|
||||||
|
## Bibliography auxiliary files (bibtex/biblatex/biber):
|
||||||
|
*.bbl
|
||||||
|
*.bcf
|
||||||
|
*.blg
|
||||||
|
*-blx.aux
|
||||||
|
*-blx.bib
|
||||||
|
*.run.xml
|
||||||
|
|
||||||
|
## Build tool auxiliary files:
|
||||||
|
*.fdb_latexmk
|
||||||
|
*.synctex
|
||||||
|
*.synctex(busy)
|
||||||
|
*.synctex.gz
|
||||||
|
*.synctex.gz(busy)
|
||||||
|
*.pdfsync
|
||||||
|
|
||||||
|
## Build tool directories for auxiliary files
|
||||||
|
# latexrun
|
||||||
|
latex.out/
|
||||||
|
|
||||||
|
## Auxiliary and intermediate files from other packages:
|
||||||
|
# algorithms
|
||||||
|
*.alg
|
||||||
|
*.loa
|
||||||
|
|
||||||
|
# achemso
|
||||||
|
acs-*.bib
|
||||||
|
|
||||||
|
# amsthm
|
||||||
|
*.thm
|
||||||
|
|
||||||
|
# beamer
|
||||||
|
*.nav
|
||||||
|
*.pre
|
||||||
|
*.snm
|
||||||
|
*.vrb
|
||||||
|
|
||||||
|
# changes
|
||||||
|
*.soc
|
||||||
|
|
||||||
|
# comment
|
||||||
|
*.cut
|
||||||
|
|
||||||
|
# cprotect
|
||||||
|
*.cpt
|
||||||
|
|
||||||
|
# elsarticle (documentclass of Elsevier journals)
|
||||||
|
*.spl
|
||||||
|
|
||||||
|
# endnotes
|
||||||
|
*.ent
|
||||||
|
|
||||||
|
# fixme
|
||||||
|
*.lox
|
||||||
|
|
||||||
|
# feynmf/feynmp
|
||||||
|
*.mf
|
||||||
|
*.mp
|
||||||
|
*.t[1-9]
|
||||||
|
*.t[1-9][0-9]
|
||||||
|
*.tfm
|
||||||
|
|
||||||
|
#(r)(e)ledmac/(r)(e)ledpar
|
||||||
|
*.end
|
||||||
|
*.?end
|
||||||
|
*.[1-9]
|
||||||
|
*.[1-9][0-9]
|
||||||
|
*.[1-9][0-9][0-9]
|
||||||
|
*.[1-9]R
|
||||||
|
*.[1-9][0-9]R
|
||||||
|
*.[1-9][0-9][0-9]R
|
||||||
|
*.eledsec[1-9]
|
||||||
|
*.eledsec[1-9]R
|
||||||
|
*.eledsec[1-9][0-9]
|
||||||
|
*.eledsec[1-9][0-9]R
|
||||||
|
*.eledsec[1-9][0-9][0-9]
|
||||||
|
*.eledsec[1-9][0-9][0-9]R
|
||||||
|
|
||||||
|
# glossaries
|
||||||
|
*.acn
|
||||||
|
*.acr
|
||||||
|
*.glg
|
||||||
|
*.glo
|
||||||
|
*.gls
|
||||||
|
*.glsdefs
|
||||||
|
*.lzo
|
||||||
|
*.lzs
|
||||||
|
|
||||||
|
# uncomment this for glossaries-extra (will ignore makeindex's style files!)
|
||||||
|
# *.ist
|
||||||
|
|
||||||
|
# gnuplottex
|
||||||
|
*-gnuplottex-*
|
||||||
|
|
||||||
|
# gregoriotex
|
||||||
|
*.gaux
|
||||||
|
*.gtex
|
||||||
|
|
||||||
|
# htlatex
|
||||||
|
*.4ct
|
||||||
|
*.4tc
|
||||||
|
*.idv
|
||||||
|
*.lg
|
||||||
|
*.trc
|
||||||
|
*.xref
|
||||||
|
|
||||||
|
# hyperref
|
||||||
|
*.brf
|
||||||
|
|
||||||
|
# knitr
|
||||||
|
*-concordance.tex
|
||||||
|
# TODO Uncomment the next line if you use knitr and want to ignore its generated tikz files
|
||||||
|
# *.tikz
|
||||||
|
*-tikzDictionary
|
||||||
|
|
||||||
|
# listings
|
||||||
|
*.lol
|
||||||
|
|
||||||
|
# luatexja-ruby
|
||||||
|
*.ltjruby
|
||||||
|
|
||||||
|
# makeidx
|
||||||
|
*.idx
|
||||||
|
*.ilg
|
||||||
|
*.ind
|
||||||
|
|
||||||
|
# minitoc
|
||||||
|
*.maf
|
||||||
|
*.mlf
|
||||||
|
*.mlt
|
||||||
|
*.mtc
|
||||||
|
*.mtc[0-9]*
|
||||||
|
*.slf[0-9]*
|
||||||
|
*.slt[0-9]*
|
||||||
|
*.stc[0-9]*
|
||||||
|
|
||||||
|
# minted
|
||||||
|
_minted*
|
||||||
|
*.pyg
|
||||||
|
|
||||||
|
# morewrites
|
||||||
|
*.mw
|
||||||
|
|
||||||
|
# nomencl
|
||||||
|
*.nlg
|
||||||
|
*.nlo
|
||||||
|
*.nls
|
||||||
|
|
||||||
|
# pax
|
||||||
|
*.pax
|
||||||
|
|
||||||
|
# pdfpcnotes
|
||||||
|
*.pdfpc
|
||||||
|
|
||||||
|
# sagetex
|
||||||
|
*.sagetex.sage
|
||||||
|
*.sagetex.py
|
||||||
|
*.sagetex.scmd
|
||||||
|
|
||||||
|
# scrwfile
|
||||||
|
*.wrt
|
||||||
|
|
||||||
|
# sympy
|
||||||
|
*.sout
|
||||||
|
*.sympy
|
||||||
|
sympy-plots-for-*.tex/
|
||||||
|
|
||||||
|
# pdfcomment
|
||||||
|
*.upa
|
||||||
|
*.upb
|
||||||
|
|
||||||
|
# pythontex
|
||||||
|
*.pytxcode
|
||||||
|
pythontex-files-*/
|
||||||
|
|
||||||
|
# tcolorbox
|
||||||
|
*.listing
|
||||||
|
|
||||||
|
# thmtools
|
||||||
|
*.loe
|
||||||
|
|
||||||
|
# TikZ & PGF
|
||||||
|
*.dpth
|
||||||
|
*.md5
|
||||||
|
*.auxlock
|
||||||
|
|
||||||
|
# todonotes
|
||||||
|
*.tdo
|
||||||
|
|
||||||
|
# vhistory
|
||||||
|
*.hst
|
||||||
|
*.ver
|
||||||
|
|
||||||
|
# easy-todo
|
||||||
|
*.lod
|
||||||
|
|
||||||
|
# xcolor
|
||||||
|
*.xcp
|
||||||
|
|
||||||
|
# xmpincl
|
||||||
|
*.xmpi
|
||||||
|
|
||||||
|
# xindy
|
||||||
|
*.xdy
|
||||||
|
|
||||||
|
# xypic precompiled matrices and outlines
|
||||||
|
*.xyc
|
||||||
|
*.xyd
|
||||||
|
|
||||||
|
# endfloat
|
||||||
|
*.ttt
|
||||||
|
*.fff
|
||||||
|
|
||||||
|
# Latexian
|
||||||
|
TSWLatexianTemp*
|
||||||
|
|
||||||
|
## Editors:
|
||||||
|
# WinEdt
|
||||||
|
*.bak
|
||||||
|
*.sav
|
||||||
|
|
||||||
|
# Texpad
|
||||||
|
.texpadtmp
|
||||||
|
|
||||||
|
# LyX
|
||||||
|
*.lyx~
|
||||||
|
|
||||||
|
# Kile
|
||||||
|
*.backup
|
||||||
|
|
||||||
|
# gummi
|
||||||
|
.*.swp
|
||||||
|
|
||||||
|
# KBibTeX
|
||||||
|
*~[0-9]*
|
||||||
|
|
||||||
|
# TeXnicCenter
|
||||||
|
*.tps
|
||||||
|
|
||||||
|
# auto folder when using emacs and auctex
|
||||||
|
./auto/*
|
||||||
|
*.el
|
||||||
|
|
||||||
|
# expex forward references with \gathertags
|
||||||
|
*-tags.tex
|
||||||
|
|
||||||
|
# standalone packages
|
||||||
|
*.sta
|
||||||
|
|
||||||
|
# Makeindex log files
|
||||||
|
*.lpz
|
||||||
|
|
||||||
|
# xwatermark package
|
||||||
|
*.xwm
|
||||||
|
|
||||||
|
# REVTeX puts footnotes in the bibliography by default, unless the nofootinbib
|
||||||
|
# option is specified. Footnotes are the stored in a file with suffix Notes.bib.
|
||||||
|
# Uncomment the next line to have this generated file ignored.
|
||||||
|
#*Notes.bib
|
||||||
|
|
@ -0,0 +1,661 @@
|
||||||
|
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 19 November 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
Developers that use our General Public Licenses protect your rights
|
||||||
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
|
you this License which gives you legal permission to copy, distribute
|
||||||
|
and/or modify the software.
|
||||||
|
|
||||||
|
A secondary benefit of defending all users' freedom is that
|
||||||
|
improvements made in alternate versions of the program, if they
|
||||||
|
receive widespread use, become available for other developers to
|
||||||
|
incorporate. Many developers of free software are heartened and
|
||||||
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
|
The GNU Affero General Public License is designed specifically to
|
||||||
|
ensure that, in such cases, the modified source code becomes available
|
||||||
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
|
An older license, called the Affero General Public License and
|
||||||
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
|
this license.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your version
|
||||||
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
|
Source of your version by providing access to the Corresponding Source
|
||||||
|
from a network server at no charge, through some standard or customary
|
||||||
|
means of facilitating copying of software. This Corresponding Source
|
||||||
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
|
following paragraph.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the work with which it is combined will remain governed by version
|
||||||
|
3 of the GNU General Public License.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU Affero General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If your software can interact with users remotely through a computer
|
||||||
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for the
|
||||||
|
specific requirements.
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
432
README.md
432
README.md
|
|
@ -1,406 +1,74 @@
|
||||||
# Nodes
|
# Blender Maxwell
|
||||||
**LEGEND**:
|
*A tool for fast, intuitive, and real-time design and visualization of Maxwell PDE Simulations in Blender 3D*.
|
||||||
- [-] Exists but doesn't quite work good enough.
|
|
||||||
- [x] Done to working degree (the standard is "good enough for the demo").
|
|
||||||
- See check marks underneath
|
|
||||||
- [?] Unsure whether we should do this.
|
|
||||||
|
|
||||||
## Inputs
|
**WARNING: This is alpha software. Expect bugs, lacking documentation, and jankiness. Expect breaking changes without warning. Here be dragons, growl growl...**
|
||||||
[x] Wave Constant
|
|
||||||
- [x] Implement export of frequency / wavelength array/range.
|
|
||||||
[-] Unit System
|
|
||||||
- [ ] Implement presets, including "Tidy3D" and "Blender", shown in the label row.
|
|
||||||
|
|
||||||
[ ] Constants / Scientific Constant
|
Blender Maxwell is a tool for creating and analyzing electromagnetic PDE simulations, with a particular focus on nano-/micro-scale phenomena.
|
||||||
[x] Constants / Number Constant
|
In particular, this tool seeks to make working with FDTD ("Finite-Difference Time-Domain") intuitive and fun:
|
||||||
[ ] Constants / Physical Constant
|
|
||||||
- [ ] Pol: Elliptical plot viz
|
|
||||||
- [ ] Pol: Poincare sphere viz
|
|
||||||
[x] Constants / Blender Constant
|
|
||||||
|
|
||||||
[x] Web / Tidy3D Web Importer
|
- **Rapid Node-Based Simulation Design and Visualization**: Rapidly create and visualize complex FDTD simulations with a novel visual programming language, implemented within Blender's (<https://www.blender.org/>) Python API.
|
||||||
|
- **Deep Tidy3D Integration**: Submit, run, monitor, and retrieve FDTD simulation results from the high-performance, state-of-the-art commercial FDTD solver "Tidy3D" (<https://www.flexcompute.com/tidy3d/solver/>), leveraging their Python client library `tidy3d`.
|
||||||
|
|
||||||
[ ] File Import / JSON File Import
|
**Development of this tool is made possible with support from the Technical University of Denmark / DTU Electro / Metamaterials Department. They provided the opportunity to develop the tool as part of the author's BSc Eng thesis, and provided funding for a professional Tidy3D license.**
|
||||||
- [ ] Dropdown to choose various supported JSON-sourced objects incl.
|
|
||||||
[ ] File Import / Tidy3D File Import
|
|
||||||
- [ ] Implement HDF-based import of Tidy3D-exported object (which includes ex. mesh data and such)
|
|
||||||
[ ] File Import / Array File Import
|
|
||||||
- [ ] Standardize 1D and 2D array loading/saving on numpy's savetxt with gzip enabled.
|
|
||||||
- [ ] Implement datatype dropdown to guide format from disk, prefilled to detected.
|
|
||||||
- [ ] Implement unit system input to guide conversion from numpy data type.
|
|
||||||
- [ ] Implement a LazyValue to provide a data path that avoids having to load massive arrays every time always.
|
|
||||||
|
|
||||||
## Outputs
|
## Key Features
|
||||||
[x] Viewer
|
- **Parametric Design**: Leverage Blender's parametric, non-destructive geometry generator: "Geometry Nodes". <https://docs.blender.org/manual/en/latest/modeling/geometry_nodes/introduction.html>).
|
||||||
- [ ] **BIG ONE**: Remove image preview when disabling plots.
|
- **Live Processing and Visualization**: Quickly understand the nature of data flowing through the node graph, be it a simulation input or output, with the help of (soft-)real-time 2D plots and 3D visualizations tailored to each node.
|
||||||
- [ ] Either enforce singleton, or find a way to have several viewers at the same time.
|
- **Prioritization of UX**: Much work has gone into node graphs and workflows feeling and acting "right". Here, "right" is an ideal of optimizing for clarity, responsiveness, and features, in roughly that order.
|
||||||
- [ ] A setting that live-previews just a value.
|
|
||||||
- [ ] Pop-up multiline string print as alternative to console print.
|
|
||||||
- [x] Toggleable auto-plot, auto-3D-preview, auto-value-view, (?)auto-text-view.
|
|
||||||
|
|
||||||
[x] Web Export / Tidy3D Web Exporter
|
## "Free" in License and Spirit
|
||||||
- [ ] We need better ways of doing checks before uploading, like for monitor data size. Maybe a SimInfo node?
|
Blender Maxwell is **free (as in freedom) software** (aka. *open source*).
|
||||||
- [ ] We need to be able to "delete and re-upload" (or maybe just delete from the interface).
|
It endeavors to **discourage** lock-in:
|
||||||
- [x] Implement estimation of monitor storage
|
- All simulation components and results are easily imported and exported as open formats, `.json`, `.hdf`, `.png` for plots, etc.. *This is especially possible thanks to the fully open-source `tidy3d` client.*
|
||||||
- [x] Implement cost estimation
|
- Simulation `.blend` files can be **freely shared and used** by absolutely anyone (with the sole exception of *running new simulations on the Tidy3D cloud*, which requires a Tidy3D license + API Key). *This is possible because Blender (and its file format `.blend`) is free (as in freedom) software, meaning the design and results of your work will never be locked up*.
|
||||||
- [?] Merge with the Tidy3D File Import (since both are working with HDFs; the web one only really does downloading too).
|
- The entire simulation workspace is scriptable. This makes it easy to write custom scripts to fitting experimental material properties from specialized formats, auto-generating simulation node graphs for educational purposes, and more.
|
||||||
|
- The license (see License section) enables anyone to ex. to make their own nodes, examine the way certain operations are implemented, audit the source code (to comply with ex. institutional security policies), and/or make similar software by copy-pasting any useful parts of this program.
|
||||||
|
|
||||||
[x] File Export / JSON File Export
|
**We hope you'll consider saying hello in an Issue, reporting bugs, and/or contributing any changes you find useful!**
|
||||||
[ ] File Import / Tidy3D File Export
|
|
||||||
- [ ] Implement HDF-based export of Tidy3D-exported object (which includes ex. mesh data and such)
|
|
||||||
[ ] File Export / Array File Export
|
|
||||||
- [ ] Implement datatype dropdown to guide format on disk.
|
|
||||||
- [ ] Implement unit system input to guide conversion to numpy data type.
|
|
||||||
- [ ] Standardize 1D and 2D array loading/saving on numpy's savetxt with gzip enabled.
|
|
||||||
|
|
||||||
## Viz
|
|
||||||
[x] Monitor Data Viz
|
|
||||||
- [x] Implement dropdown to choose which monitor in the SimulationData should be visualized (based on which are available in the SimulationData), and implement visualization based on every kind of monitor-adjascent output data type (<https://docs.flexcompute.com/projects/tidy3d/en/latest/api/output_data.html>)
|
|
||||||
- [ ] Project field values onto a plane object (managed)
|
|
||||||
|
|
||||||
## Sources
|
|
||||||
[x] Temporal Shapes / Gaussian Pulse Temporal Shape
|
|
||||||
[x] Temporal Shapes / Continuous Wave Temporal Shape
|
|
||||||
[ ] Temporal Shapes / Symbolic Temporal Shape
|
|
||||||
- [ ] Specify a Sympy function to generate appropriate array based on
|
|
||||||
[ ] Temporal Shapes / Array Temporal Shape
|
|
||||||
|
|
||||||
[x] Point Dipole Source
|
# Simulator Support
|
||||||
- [ ] Consider a "real" mesh - the empty kind of gets stuck inside of the sim domain.
|
Only Tidy3D is supported, via the `tidy3d` client.
|
||||||
[-] Plane Wave Source
|
|
||||||
- [ ] **IMPORTANT**: Fix the math so that an actually valid construction emerges!!
|
|
||||||
- [x] Implement an oriented vector input with 3D preview.
|
|
||||||
[ ] Uniform Current Source
|
|
||||||
[ ] TFSF Source
|
|
||||||
|
|
||||||
[ ] Gaussian Beam Source
|
`tidy3d` was chosen as the "lingua franca" client for declarative FDTD simulation definition, in large part because it is "just that good".
|
||||||
[ ] Astigmatic Gaussian Beam Source
|
Other simulators are theoretically possible to integrate; however, this would involve writing a translation layer from the `tidy3d`.
|
||||||
|
|
||||||
[ ] Mode Source
|
## Why Tidy3D?
|
||||||
|
FDTD simulation can easily take days, be very complex to design, and fail in intricate ways.
|
||||||
|
|
||||||
[ ] Array Source / EH Array Source
|
As what might be the fastest FDTD simulator on the market today, Tidy3D is the "secret sauce" of the rapid iteration loops that Blender Maxwell attempts to help realize.
|
||||||
[ ] Array Source / EH Equivilance Array Source
|
It turns **days into minutes** when running useful, real-world simulation tasks.
|
||||||
|
Moreover, Tidy3D provides a very well-made and -documented open-source Python client library, `tidy3d`, which is a massively helpful resource when developing such a tool.
|
||||||
|
|
||||||
## Mediums
|
Due to its quality, performance, and lack of "lock-in", I believe Tidy3D is an ideal and future-proof choice of simulator integration for this project.
|
||||||
[x] Library Medium
|
|
||||||
- [ ] Implement frequency range output
|
|
||||||
[ ] PEC Medium
|
|
||||||
[ ] Isotropic Medium
|
|
||||||
[ ] Anisotropic Medium
|
|
||||||
|
|
||||||
[ ] Sellmeier Medium
|
|
||||||
[ ] Drude Medium
|
|
||||||
[ ] Drude-Lorentz Medium
|
|
||||||
[ ] Debye Medium
|
|
||||||
[ ] Pole-Residue Medium
|
|
||||||
|
|
||||||
[ ] Non-Linearity / `chi_3` Susceptibility Non-Linearity
|
|
||||||
[ ] Non-Linearity / Two-Photon Absorption Non-Linearity
|
|
||||||
[ ] Non-Linearity / Kerr Non-Linearity
|
|
||||||
|
|
||||||
[ ] Space/Time epsilon/mu Modulation
|
# License
|
||||||
|
This software is provided under the terms of the "AGPL software license", as specified in the `LICENSE` file.
|
||||||
|
If you would like a different license, please contact the author(s).
|
||||||
|
|
||||||
## Structures
|
In general (*not legal advice*), AGPL means you can **use, modify, redistribute, and even sell (copies of)** this project (or simulation node graphs made with it) for any reason, **so long as you also provide these same kinds of freedoms to anyone you share it (copies) with** (including stating any changes you made).
|
||||||
[ ] BLObject Structure
|
|
||||||
[x] GeoNodes Structure
|
|
||||||
- [x] Rewrite the `bl_socket_map.py`
|
|
||||||
- [x] Use the modifier itself as memory, via the ManagedObj
|
|
||||||
- [?] When GeoNodes themselves declare panels, implement a grid-like tab system to select which sockets should be exposed in the node at a given point in time.
|
|
||||||
|
|
||||||
[ ] Primitive Structures / Plane Structure
|
If you wish to contribute, you must also agree to do so under the terms of this license.
|
||||||
[x] Primitive Structures / Box Structure
|
For more information on AGPL, see (<https://www.gnu.org/licenses/gpl-faq.html>) or seek legal advice.
|
||||||
[x] Primitive Structures / Sphere Structure
|
|
||||||
[ ] Primitive Structures / Cylinder Structure
|
|
||||||
[ ] Primitive Structures / Ring Structure
|
|
||||||
[ ] Primitive Structures / Capsule Structure
|
|
||||||
[ ] Primitive Structures / Cone Structure
|
|
||||||
|
|
||||||
## Monitors
|
## Do's and Don'ts
|
||||||
- **ALL**: "Steady-State" / "Time Domain" (only if relevant).
|
It can sometimes be a bit confusing to figure out exactly what you're allowed to do with a piece of software.
|
||||||
|
If in doubt, don't hesitate to ask.
|
||||||
|
|
||||||
[x] E/H Field Monitor
|
**Do**: Anything you want with exported simulation output, ex. plots, images, arrays/fields (as ex. HDF, OpenVDB, text, etc.), renders, and so on.
|
||||||
- [x] Monitor Domain as dropdown with Frequency or Time
|
To be very clear, and to dispel a common misunderstanding: AGPL doesn't apply to exported results; exported results are NOT subject to AGPL(-compatible) terms.
|
||||||
- [x] Axis-aligned planar 2D (pixel) and coord-aligned box 3D (voxel).
|
In general, when you share something you made **using** Blender Maxwell, AGPL DOESN'T apply; if you share something you made **including** part (or all) of Blender Maxwell, AGPL DOES apply.
|
||||||
[ ] Field Power Flux Monitor
|
|
||||||
- [ ] Monitor Domain as dropdown with Frequency or Time
|
|
||||||
- [ ] Axis-aligned planar 2D (pixel) and coord-aligned box 3D (voxel).
|
|
||||||
[ ] \epsilon Tensor Monitor
|
|
||||||
- [ ] Axis-aligned planar 2D (pixel) and coord-aligned box 3D (voxel).
|
|
||||||
[ ] Diffraction Monitor
|
|
||||||
- [ ] Axis-aligned planar 2D (pixel)
|
|
||||||
|
|
||||||
[ ] Projected E/H Field Monitor / Cartesian Projected E/H Field Monitor
|
**Don't**: Share `.blend` files containing a Blender Maxwell node graph **without an AGPL(-compatible) license**.
|
||||||
- [ ] Use to implement the metalens: <https://docs.flexcompute.com/projects/tidy3d/en/latest/notebooks/Metalens.html>
|
Since node graphs are *source code* (visual code is also code) for software that *includes part of Blender Maxwell*, sharing a node graph requires *sharing a part of Blender Maxwell*.
|
||||||
[ ] Projected E/H Field Monitor / Angle Projected E/H Field Monitor
|
Therefore, the AGPL applies.
|
||||||
[ ] Projected E/H Field Monitor / K-Space Projected E/H Field Monitor
|
|
||||||
|
|
||||||
- **TODO**: "Modal" solver monitoring (seems to be some kind of spatial+frequency feature, which an EM field can be decomposed into using a specially configured solver, which can be used to look for very particular kinds of effects by constraining investigations of a solver result to filter out everything that isn't these particular modes aka. features. Kind of a fourier-based redimensionalization, almost).
|
**Do**: Take a moment to explore the dependencies, including Blender and `tidy3d` of course, but also `numpy`, `sympy`, `xarray`, `networkx`, `pydantic`, `jax` etc.!
|
||||||
|
They are not only fantastic pieces of engineering, but are themselves licensed under similar "open source" terms that made this tool possible.
|
||||||
|
|
||||||
## Simulations
|
**Don't**: Worry about whether your `.blend` file is licensed correctly.
|
||||||
[-] FDTDSim
|
By default, Blender Maxwell should include license information in the node graph (feel free to change the license, just mind that your choice is AGPL-compatible).
|
||||||
|
When you do share simulation `.blend`s, it's probably a good idea to briefly communicate the terms anyway, just to everyone's on the same page.
|
||||||
[x] Sim Domain
|
|
||||||
- [ ] By-Medium batching of Structures when building the td.Simulation object, which can have significant performance implications.
|
|
||||||
|
|
||||||
[x] Boundary Conds
|
|
||||||
- [x] Rename from Bounds / BoundBox
|
|
||||||
[ ] Boundary Cond / PML Bound Face
|
|
||||||
- [ ] Implement dropdown for "Normal" and "Stable"
|
|
||||||
[ ] Boundary Cond / PEC Bound Face
|
|
||||||
[ ] Boundary Cond / PMC Bound Face
|
|
||||||
[ ] Boundary Cond / Bloch Bound Face
|
|
||||||
[ ] Boundary Cond / Periodic Bound Face
|
|
||||||
[ ] Boundary Cond / Absorbing Bound Face
|
|
||||||
|
|
||||||
[ ] Sim Grid
|
|
||||||
[ ] Sim Grid Axes / Auto Sim Grid Axis
|
|
||||||
[ ] Sim Grid Axes / Manual Sim Grid Axis
|
|
||||||
[ ] Sim Grid Axes / Uniform Sim Grid Axis
|
|
||||||
[ ] Sim Grid Axes / Array Sim Grid Axis
|
|
||||||
|
|
||||||
## Converters
|
|
||||||
[ ] Math
|
|
||||||
- [ ] Implement common operations w/secondary choice of socket type based on a custom internal data structure
|
|
||||||
- [ ] Implement angfreq/frequency/vacwl conversion.
|
|
||||||
[ ] Separate
|
|
||||||
[ ] Combine
|
|
||||||
- [ ] Implement concatenation of sim-critical socket types into their multi-type
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# GeoNodes
|
|
||||||
[ ] Tests / Monkey (suzanne deserves to be simulated, she may need manifolding up though :))
|
|
||||||
[ ] Tests / Wood Pile
|
|
||||||
|
|
||||||
[ ] Primitives / Plane
|
|
||||||
[ ] Primitives / Box
|
|
||||||
[ ] Primitives / Sphere
|
|
||||||
[ ] Primitives / Cylinder
|
|
||||||
[ ] Primitives / Ring
|
|
||||||
[ ] Primitives / Capsule
|
|
||||||
[ ] Primitives / Cone
|
|
||||||
|
|
||||||
[ ] Array / Square Array **NOTE: Ring and cylinder**
|
|
||||||
[ ] Array / Hex Array **NOTE: Ring and cylinder**
|
|
||||||
[ ] Hole Array / Square Hole Array: Takes a primitive hole shape.
|
|
||||||
[ ] Hole Array / Hex Hole Array: Takes a primitive hole shape.
|
|
||||||
[ ] Cavity Array / Hex Array w/ L-Cavity
|
|
||||||
[ ] Cavity Array / Hex Array w/ H-Cavity
|
|
||||||
|
|
||||||
[ ] Crystal Sphere Lattice / Sphere FCC Array
|
|
||||||
[ ] Crystal Sphere Lattice / Sphere BCC Array
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Benchmark / Example Sims
|
|
||||||
[ ] Research-Grade Experiment
|
|
||||||
- Membrane 15nm thickness suspended in air
|
|
||||||
- Square lattice of holes period 900nm (900nm between each hole, air inside holes)
|
|
||||||
- Holes square radius 100nm
|
|
||||||
- Square lattice
|
|
||||||
- Analysis of transmission
|
|
||||||
- Guided mode resonance
|
|
||||||
[ ] Tunable Chiral Metasurface <https://docs.flexcompute.com/projects/tidy3d/en/latest/notebooks/TunableChiralMetasurface.html>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Sockets
|
|
||||||
## Basic
|
|
||||||
[x] Any
|
|
||||||
[x] Bool
|
|
||||||
[x] String
|
|
||||||
- [ ] Rename from "Text"
|
|
||||||
[x] File Path
|
|
||||||
[x] Color
|
|
||||||
|
|
||||||
## Number
|
|
||||||
[x] Integer
|
|
||||||
[x] Rational
|
|
||||||
- [ ] Implement constrained SympyExpr check for Rational.
|
|
||||||
[x] Real
|
|
||||||
- [ ] Implement min/max for ex. 0..1 factor support.
|
|
||||||
- [ ] Implement constrained SympyExpr check for Rational.
|
|
||||||
[x] Complex
|
|
||||||
|
|
||||||
## Blender
|
|
||||||
[x] Object
|
|
||||||
- [ ] Implement default SocketDef object name
|
|
||||||
[x] Collection
|
|
||||||
- [ ] Implement default SocketDef collection name
|
|
||||||
|
|
||||||
[x] Image
|
|
||||||
- [ ] Implement default SocketDef image name
|
|
||||||
|
|
||||||
[x] GeoNodes
|
|
||||||
- [ ] Implement default SocketDef geonodes name
|
|
||||||
[x] Text
|
|
||||||
- [ ] Implement default SocketDef object name
|
|
||||||
|
|
||||||
## Maxwell
|
|
||||||
[x] Bound Conds
|
|
||||||
[ ] Bound Cond
|
|
||||||
|
|
||||||
[x] Medium
|
|
||||||
[ ] Medium Non-Linearity
|
|
||||||
|
|
||||||
[x] Source
|
|
||||||
[ ] Temporal Shape
|
|
||||||
- [ ] Sane-default pulses for easy access.
|
|
||||||
|
|
||||||
[ ] Structure
|
|
||||||
[ ] Monitor
|
|
||||||
|
|
||||||
[ ] FDTD Sim
|
|
||||||
[ ] Sim Domain
|
|
||||||
- [?] Toggleable option to sync the simulation time duration to the scene end time (how to handle FPS vs time-step? Should we adjust the FPS such that there is one time step per frame, while keeping the definition of "second" aligned to a unit system?)
|
|
||||||
[ ] Sim Grid
|
|
||||||
[ ] Sim Grid Axis
|
|
||||||
|
|
||||||
[ ] Simulation Data
|
|
||||||
|
|
||||||
## Tidy3D
|
|
||||||
[x] Cloud Task
|
|
||||||
- [ ] Implement switcher for API-key-having config filconfig file vs. direct entry of API key. It should be auto-filled with the config file when such a thing exists.
|
|
||||||
|
|
||||||
## Physical
|
|
||||||
[x] Unit System
|
|
||||||
- [ ] Implement more comprehensible UI; honestly, probably with the new panels (<https://developer.blender.org/docs/release_notes/4.1/python_api/>)
|
|
||||||
|
|
||||||
[x] Time
|
|
||||||
|
|
||||||
[x] Angle
|
|
||||||
[ ] Solid Angle (steradian)
|
|
||||||
|
|
||||||
[x] Frequency (hertz)
|
|
||||||
[ ] Angular Frequency (`rad*hertz`)
|
|
||||||
### Cartesian
|
|
||||||
[x] Length
|
|
||||||
[x] Area
|
|
||||||
[x] Volume
|
|
||||||
|
|
||||||
[ ] Point 1D
|
|
||||||
[ ] Point 2D
|
|
||||||
[x] Point 3D
|
|
||||||
|
|
||||||
[ ] Size 2D
|
|
||||||
[x] Size 3D
|
|
||||||
|
|
||||||
[ ] Rotation 3D
|
|
||||||
- [ ] Implement Euler methods
|
|
||||||
- [ ] Implement Quaternion methods
|
|
||||||
### Mechanical
|
|
||||||
[ ] Mass
|
|
||||||
|
|
||||||
[x] Speed
|
|
||||||
[ ] Velocity 3D
|
|
||||||
[x] Acceleration Scalar
|
|
||||||
[ ] Acceleration 3D
|
|
||||||
[x] Force Scalar
|
|
||||||
[ ] Force 3D
|
|
||||||
[ ] Pressure
|
|
||||||
### Energy
|
|
||||||
[ ] Energy (joule)
|
|
||||||
[ ] Power (watt)
|
|
||||||
[ ] Temperature
|
|
||||||
### Electrodynamical
|
|
||||||
[ ] Current (ampere)
|
|
||||||
[ ] Current Density 3D
|
|
||||||
|
|
||||||
[ ] Charge (coulomb)
|
|
||||||
[ ] Voltage (volts)
|
|
||||||
[ ] Capacitance (farad)
|
|
||||||
[ ] Resistance (ohm)
|
|
||||||
[ ] Electric Conductance (siemens)
|
|
||||||
|
|
||||||
[ ] Magnetic Flux (weber)
|
|
||||||
[ ] Magnetic Flux Density (tesla)
|
|
||||||
[ ] Inductance (henry)
|
|
||||||
|
|
||||||
[ ] Electric Field 3D (`volt*meter`)
|
|
||||||
[ ] Magnetic Field 3D (tesla)
|
|
||||||
### Luminal
|
|
||||||
[ ] Luminous Intensity (candela)
|
|
||||||
[ ] Luminous Flux (lumen)
|
|
||||||
[ ] Illuminance (lux)
|
|
||||||
### Optical
|
|
||||||
[ ] Jones Polarization
|
|
||||||
[ ] Polarization (Stokes)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Style
|
|
||||||
[ ] Rethink the meaning of color and shapes in node sockets, including whether dynamic functionality is needed when it comes to socket shape (ex. it might be nice to know whether a socket is array-like or uses units).
|
|
||||||
[ ] Rethink the meaning of color and shapes in node sockets, including whether dynamic functionality is needed when it comes to socket shape.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Architecture
|
|
||||||
## Registration and Contracts
|
|
||||||
[x] Finish the contract code converting from Blender sockets to our sockets based on dimensionality and the property description.
|
|
||||||
[ ] Refactor the node category code; it's ugly.
|
|
||||||
[?] Would be nice with some kind of indicator somewhere to help set good socket descriptions when using geonodes and wanting units.
|
|
||||||
|
|
||||||
## Managed Objects
|
|
||||||
[x] Implement modifier support on the managed BL object, with special attention paid to the needs of the GeoNodes socket.
|
|
||||||
- [x] Implement preview toggling too, ex. using the relevant node tree collections
|
|
||||||
- Remember, the managed object is "dumb". It's the node's responsibility to react to any relevant `on_value_change`, and forward all state needed by the modifier to the managed obj. It's only the managed obj's responsibility to not update any modifier value that wouldn't change anything.
|
|
||||||
[ ] Implement loading the xarray-defined voxels into OpenVDB, saving it, and loading it as a managed BL object with the volume setting.
|
|
||||||
[ ] Implement basic jax-driven volume voxel processing, especially cube based slicing.
|
|
||||||
[ ] Implement jax-driven linear interpolation of volume voxels to an image texture, whose pixels are sized according to the dimensions of another managed plane object (perhaps a uniquely described Managed BL object itself).
|
|
||||||
|
|
||||||
## Utils or Services
|
|
||||||
[ ] Dedicated module for managing the interaction with the tidy3d cloud, to help nuke all the random caches out of existance.
|
|
||||||
|
|
||||||
## Node Base Class
|
|
||||||
[ ] Dedicated `draw_preview`-type draw functions for plot customizations.
|
|
||||||
- [ ] For now, previewing isn't something I think should be part of the node
|
|
||||||
[ ] Custom `@cache`/`@lru_cache`/`@cached_property` which caches by instance ID (possibly based on `beartype` or `pydantic`).
|
|
||||||
[ ] When presets are used, if a preset is selected and the user alters a preset setting, then dynamically switch the preset indicator back to "Custom" to indicate that there is no active preset
|
|
||||||
[ ] It seems that `node.inputs` and `node.outputs` allows the use of a `move` method, which may allow reordering sockets dynamically, which we should expose to the user as user-configurable ordering rules (maybe resolved with a constraint solver).
|
|
||||||
[?] Mechanism for dynamic names (ex. "Library Medium" becoming "Au Medium")
|
|
||||||
[-] Mechanism for selecting a blender object managed by a particular node.
|
|
||||||
[ ] Mechanism for ex. specially coloring a node that is currently participating in the preview.
|
|
||||||
[ ] Custom callbacks when deleting a node (in `free()`), to ex. delete all previews with the viewer node.
|
|
||||||
|
|
||||||
## Socket Base Class
|
|
||||||
[ ] A feature `use_array` which allows a socket to declare that it can be both a single value and array-like (possibly constrained to a given shape). This should also allow the SocketDef to request that the input socket be initialised as a multi-input socket, once Blender updates to support those.
|
|
||||||
- [ ] Implement a shape-selector, with a dropdown for dimensionality and an appropriate `IntegerVectorProperty` for each kind of shape (supporting also straight-up inf), which is declared to the node that supports array-likeness so it can decide how exactly to expose properties in the array-like context of things.
|
|
||||||
[ ] Make `to_socket`s no-consent to new links from `from_socket`s of differing type (we'll see if this controls the typing story enough for now, and how much we'll need capabilities in the long run)
|
|
||||||
- [?] Alternatively, reject non matching link types, and red-mark non matching capabilities?
|
|
||||||
|
|
||||||
## Many Nodes
|
|
||||||
[ ] Implement LazyValue stuff, including LazyParamValue on a new class of constant-like input nodes that really just emit ex. sympy variables.
|
|
||||||
[?] Require a Unit System for nodes that construct Tidy3D objects
|
|
||||||
[ ] Medium Features
|
|
||||||
- [ ] Accept spatial field. Else, spatial uniformity.
|
|
||||||
- [ ] Accept non-linearity. Else, linear.
|
|
||||||
- [ ] Accept space-time modulation. Else, static.
|
|
||||||
[ ] Modal Features
|
|
||||||
- [ ] ModeSpec, for use by ModeSource, ModeMonitor, ModeSolverMonitor. Data includes ModeSolverData, ModeData, ScalarModeFieldDataArray, ModeAmpsDataArray, ModeIndexDataArray, ModeSolver.
|
|
||||||
|
|
||||||
## Development Tooling
|
|
||||||
[ ] Implement `rye` support
|
|
||||||
[ ] Setup neovim to be an ideal editor
|
|
||||||
|
|
||||||
## Version Churn
|
|
||||||
[ ] Implement real StrEnum sockets, since they appear in py3.11
|
|
||||||
[ ] Think about implementing new panels where appropriate (<https://developer.blender.org/docs/release_notes/4.1/python_api/>)
|
|
||||||
[ ] Think about using the new bl4.1 file handler API to enable drag and drop creation of appropriate nodes (for importing files without hassle).
|
|
||||||
[ ] Keep an eye on our manual `__annotations__` hacking; python 3.13 is apparently fucking with it.
|
|
||||||
[ ] Plan for multi-input sockets <https://projects.blender.org/blender/blender/commit/14106150797a6ce35e006ffde18e78ea7ae67598> (for now, just use the "Combine" node and have seperate socket types for both).
|
|
||||||
[ ] Keep an eye out for volume geonodes in 4.2 (July 16, 2024), which will better allow for more complicated volume processing (we might still want/need the jax based stuff after, but let's keep it minimal just in case)
|
|
||||||
|
|
||||||
## Packaging
|
|
||||||
[ ] Allow specifying custom dir for keeping pip dependencies, so we can unify prod and dev (currently we hard-code a dev dependency path).
|
|
||||||
[ ] Refactor top-level `__init__.py` to check dependencies first. If not everything is available, it should only register a minimal addon; specifically, a message telling the user that the addon requires additional dependencies (list which), and the button to install them. When the installation is done, re-check deps and register the rest of the addon.
|
|
||||||
[ ] Use a Modal and multiline-text-like construction to print `pip install` as we install dependencies, so that the user has an idea that something is happening.
|
|
||||||
[ ] Test on Windows
|
|
||||||
|
|
||||||
## Node Tree Cache Semantics
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# TIDY3D BUGS
|
|
||||||
- Directly running `SimulationTask.get()` is bugged - it doesn't return some fields, including `created_at`. Listing tasks by folder is not broken.
|
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,406 @@
|
||||||
|
# Nodes
|
||||||
|
**LEGEND**:
|
||||||
|
- [-] Exists but doesn't quite work good enough.
|
||||||
|
- [x] Done to working degree (the standard is "good enough for the demo").
|
||||||
|
- See check marks underneath
|
||||||
|
- [?] Unsure whether we should do this.
|
||||||
|
|
||||||
|
## Inputs
|
||||||
|
[x] Wave Constant
|
||||||
|
- [x] Implement export of frequency / wavelength array/range.
|
||||||
|
[-] Unit System
|
||||||
|
- [ ] Implement presets, including "Tidy3D" and "Blender", shown in the label row.
|
||||||
|
|
||||||
|
[ ] Constants / Scientific Constant
|
||||||
|
[x] Constants / Number Constant
|
||||||
|
[ ] Constants / Physical Constant
|
||||||
|
- [ ] Pol: Elliptical plot viz
|
||||||
|
- [ ] Pol: Poincare sphere viz
|
||||||
|
[x] Constants / Blender Constant
|
||||||
|
|
||||||
|
[x] Web / Tidy3D Web Importer
|
||||||
|
|
||||||
|
[ ] File Import / JSON File Import
|
||||||
|
- [ ] Dropdown to choose various supported JSON-sourced objects incl.
|
||||||
|
[ ] File Import / Tidy3D File Import
|
||||||
|
- [ ] Implement HDF-based import of Tidy3D-exported object (which includes ex. mesh data and such)
|
||||||
|
[ ] File Import / Array File Import
|
||||||
|
- [ ] Standardize 1D and 2D array loading/saving on numpy's savetxt with gzip enabled.
|
||||||
|
- [ ] Implement datatype dropdown to guide format from disk, prefilled to detected.
|
||||||
|
- [ ] Implement unit system input to guide conversion from numpy data type.
|
||||||
|
- [ ] Implement a LazyValue to provide a data path that avoids having to load massive arrays every time always.
|
||||||
|
|
||||||
|
## Outputs
|
||||||
|
[x] Viewer
|
||||||
|
- [ ] **BIG ONE**: Remove image preview when disabling plots.
|
||||||
|
- [ ] Either enforce singleton, or find a way to have several viewers at the same time.
|
||||||
|
- [ ] A setting that live-previews just a value.
|
||||||
|
- [ ] Pop-up multiline string print as alternative to console print.
|
||||||
|
- [x] Toggleable auto-plot, auto-3D-preview, auto-value-view, (?)auto-text-view.
|
||||||
|
|
||||||
|
[x] Web Export / Tidy3D Web Exporter
|
||||||
|
- [ ] We need better ways of doing checks before uploading, like for monitor data size. Maybe a SimInfo node?
|
||||||
|
- [ ] We need to be able to "delete and re-upload" (or maybe just delete from the interface).
|
||||||
|
- [x] Implement estimation of monitor storage
|
||||||
|
- [x] Implement cost estimation
|
||||||
|
- [?] Merge with the Tidy3D File Import (since both are working with HDFs; the web one only really does downloading too).
|
||||||
|
|
||||||
|
[x] File Export / JSON File Export
|
||||||
|
[ ] File Import / Tidy3D File Export
|
||||||
|
- [ ] Implement HDF-based export of Tidy3D-exported object (which includes ex. mesh data and such)
|
||||||
|
[ ] File Export / Array File Export
|
||||||
|
- [ ] Implement datatype dropdown to guide format on disk.
|
||||||
|
- [ ] Implement unit system input to guide conversion to numpy data type.
|
||||||
|
- [ ] Standardize 1D and 2D array loading/saving on numpy's savetxt with gzip enabled.
|
||||||
|
|
||||||
|
## Viz
|
||||||
|
[x] Monitor Data Viz
|
||||||
|
- [x] Implement dropdown to choose which monitor in the SimulationData should be visualized (based on which are available in the SimulationData), and implement visualization based on every kind of monitor-adjascent output data type (<https://docs.flexcompute.com/projects/tidy3d/en/latest/api/output_data.html>)
|
||||||
|
- [ ] Project field values onto a plane object (managed)
|
||||||
|
|
||||||
|
## Sources
|
||||||
|
[x] Temporal Shapes / Gaussian Pulse Temporal Shape
|
||||||
|
[x] Temporal Shapes / Continuous Wave Temporal Shape
|
||||||
|
[ ] Temporal Shapes / Symbolic Temporal Shape
|
||||||
|
- [ ] Specify a Sympy function to generate appropriate array based on
|
||||||
|
[ ] Temporal Shapes / Array Temporal Shape
|
||||||
|
|
||||||
|
[x] Point Dipole Source
|
||||||
|
- [ ] Consider a "real" mesh - the empty kind of gets stuck inside of the sim domain.
|
||||||
|
[-] Plane Wave Source
|
||||||
|
- [ ] **IMPORTANT**: Fix the math so that an actually valid construction emerges!!
|
||||||
|
- [x] Implement an oriented vector input with 3D preview.
|
||||||
|
[ ] Uniform Current Source
|
||||||
|
[ ] TFSF Source
|
||||||
|
|
||||||
|
[ ] Gaussian Beam Source
|
||||||
|
[ ] Astigmatic Gaussian Beam Source
|
||||||
|
|
||||||
|
[ ] Mode Source
|
||||||
|
|
||||||
|
[ ] Array Source / EH Array Source
|
||||||
|
[ ] Array Source / EH Equivilance Array Source
|
||||||
|
|
||||||
|
## Mediums
|
||||||
|
[x] Library Medium
|
||||||
|
- [ ] Implement frequency range output
|
||||||
|
[ ] PEC Medium
|
||||||
|
[ ] Isotropic Medium
|
||||||
|
[ ] Anisotropic Medium
|
||||||
|
|
||||||
|
[ ] Sellmeier Medium
|
||||||
|
[ ] Drude Medium
|
||||||
|
[ ] Drude-Lorentz Medium
|
||||||
|
[ ] Debye Medium
|
||||||
|
[ ] Pole-Residue Medium
|
||||||
|
|
||||||
|
[ ] Non-Linearity / `chi_3` Susceptibility Non-Linearity
|
||||||
|
[ ] Non-Linearity / Two-Photon Absorption Non-Linearity
|
||||||
|
[ ] Non-Linearity / Kerr Non-Linearity
|
||||||
|
|
||||||
|
[ ] Space/Time epsilon/mu Modulation
|
||||||
|
|
||||||
|
## Structures
|
||||||
|
[ ] BLObject Structure
|
||||||
|
[x] GeoNodes Structure
|
||||||
|
- [x] Rewrite the `bl_socket_map.py`
|
||||||
|
- [x] Use the modifier itself as memory, via the ManagedObj
|
||||||
|
- [?] When GeoNodes themselves declare panels, implement a grid-like tab system to select which sockets should be exposed in the node at a given point in time.
|
||||||
|
|
||||||
|
[ ] Primitive Structures / Plane Structure
|
||||||
|
[x] Primitive Structures / Box Structure
|
||||||
|
[x] Primitive Structures / Sphere Structure
|
||||||
|
[ ] Primitive Structures / Cylinder Structure
|
||||||
|
[ ] Primitive Structures / Ring Structure
|
||||||
|
[ ] Primitive Structures / Capsule Structure
|
||||||
|
[ ] Primitive Structures / Cone Structure
|
||||||
|
|
||||||
|
## Monitors
|
||||||
|
- **ALL**: "Steady-State" / "Time Domain" (only if relevant).
|
||||||
|
|
||||||
|
[x] E/H Field Monitor
|
||||||
|
- [x] Monitor Domain as dropdown with Frequency or Time
|
||||||
|
- [x] Axis-aligned planar 2D (pixel) and coord-aligned box 3D (voxel).
|
||||||
|
[ ] Field Power Flux Monitor
|
||||||
|
- [ ] Monitor Domain as dropdown with Frequency or Time
|
||||||
|
- [ ] Axis-aligned planar 2D (pixel) and coord-aligned box 3D (voxel).
|
||||||
|
[ ] \epsilon Tensor Monitor
|
||||||
|
- [ ] Axis-aligned planar 2D (pixel) and coord-aligned box 3D (voxel).
|
||||||
|
[ ] Diffraction Monitor
|
||||||
|
- [ ] Axis-aligned planar 2D (pixel)
|
||||||
|
|
||||||
|
[ ] Projected E/H Field Monitor / Cartesian Projected E/H Field Monitor
|
||||||
|
- [ ] Use to implement the metalens: <https://docs.flexcompute.com/projects/tidy3d/en/latest/notebooks/Metalens.html>
|
||||||
|
[ ] Projected E/H Field Monitor / Angle Projected E/H Field Monitor
|
||||||
|
[ ] Projected E/H Field Monitor / K-Space Projected E/H Field Monitor
|
||||||
|
|
||||||
|
- **TODO**: "Modal" solver monitoring (seems to be some kind of spatial+frequency feature, which an EM field can be decomposed into using a specially configured solver, which can be used to look for very particular kinds of effects by constraining investigations of a solver result to filter out everything that isn't these particular modes aka. features. Kind of a fourier-based redimensionalization, almost).
|
||||||
|
|
||||||
|
## Simulations
|
||||||
|
[-] FDTDSim
|
||||||
|
|
||||||
|
[x] Sim Domain
|
||||||
|
- [ ] By-Medium batching of Structures when building the td.Simulation object, which can have significant performance implications.
|
||||||
|
|
||||||
|
[x] Boundary Conds
|
||||||
|
- [x] Rename from Bounds / BoundBox
|
||||||
|
[ ] Boundary Cond / PML Bound Face
|
||||||
|
- [ ] Implement dropdown for "Normal" and "Stable"
|
||||||
|
[ ] Boundary Cond / PEC Bound Face
|
||||||
|
[ ] Boundary Cond / PMC Bound Face
|
||||||
|
[ ] Boundary Cond / Bloch Bound Face
|
||||||
|
[ ] Boundary Cond / Periodic Bound Face
|
||||||
|
[ ] Boundary Cond / Absorbing Bound Face
|
||||||
|
|
||||||
|
[ ] Sim Grid
|
||||||
|
[ ] Sim Grid Axes / Auto Sim Grid Axis
|
||||||
|
[ ] Sim Grid Axes / Manual Sim Grid Axis
|
||||||
|
[ ] Sim Grid Axes / Uniform Sim Grid Axis
|
||||||
|
[ ] Sim Grid Axes / Array Sim Grid Axis
|
||||||
|
|
||||||
|
## Converters
|
||||||
|
[ ] Math
|
||||||
|
- [ ] Implement common operations w/secondary choice of socket type based on a custom internal data structure
|
||||||
|
- [ ] Implement angfreq/frequency/vacwl conversion.
|
||||||
|
[ ] Separate
|
||||||
|
[ ] Combine
|
||||||
|
- [ ] Implement concatenation of sim-critical socket types into their multi-type
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# GeoNodes
|
||||||
|
[ ] Tests / Monkey (suzanne deserves to be simulated, she may need manifolding up though :))
|
||||||
|
[ ] Tests / Wood Pile
|
||||||
|
|
||||||
|
[ ] Primitives / Plane
|
||||||
|
[ ] Primitives / Box
|
||||||
|
[ ] Primitives / Sphere
|
||||||
|
[ ] Primitives / Cylinder
|
||||||
|
[ ] Primitives / Ring
|
||||||
|
[ ] Primitives / Capsule
|
||||||
|
[ ] Primitives / Cone
|
||||||
|
|
||||||
|
[ ] Array / Square Array **NOTE: Ring and cylinder**
|
||||||
|
[ ] Array / Hex Array **NOTE: Ring and cylinder**
|
||||||
|
[ ] Hole Array / Square Hole Array: Takes a primitive hole shape.
|
||||||
|
[ ] Hole Array / Hex Hole Array: Takes a primitive hole shape.
|
||||||
|
[ ] Cavity Array / Hex Array w/ L-Cavity
|
||||||
|
[ ] Cavity Array / Hex Array w/ H-Cavity
|
||||||
|
|
||||||
|
[ ] Crystal Sphere Lattice / Sphere FCC Array
|
||||||
|
[ ] Crystal Sphere Lattice / Sphere BCC Array
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Benchmark / Example Sims
|
||||||
|
[ ] Research-Grade Experiment
|
||||||
|
- Membrane 15nm thickness suspended in air
|
||||||
|
- Square lattice of holes period 900nm (900nm between each hole, air inside holes)
|
||||||
|
- Holes square radius 100nm
|
||||||
|
- Square lattice
|
||||||
|
- Analysis of transmission
|
||||||
|
- Guided mode resonance
|
||||||
|
[ ] Tunable Chiral Metasurface <https://docs.flexcompute.com/projects/tidy3d/en/latest/notebooks/TunableChiralMetasurface.html>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Sockets
|
||||||
|
## Basic
|
||||||
|
[x] Any
|
||||||
|
[x] Bool
|
||||||
|
[x] String
|
||||||
|
- [ ] Rename from "Text"
|
||||||
|
[x] File Path
|
||||||
|
[x] Color
|
||||||
|
|
||||||
|
## Number
|
||||||
|
[x] Integer
|
||||||
|
[x] Rational
|
||||||
|
- [ ] Implement constrained SympyExpr check for Rational.
|
||||||
|
[x] Real
|
||||||
|
- [ ] Implement min/max for ex. 0..1 factor support.
|
||||||
|
- [ ] Implement constrained SympyExpr check for Rational.
|
||||||
|
[x] Complex
|
||||||
|
|
||||||
|
## Blender
|
||||||
|
[x] Object
|
||||||
|
- [ ] Implement default SocketDef object name
|
||||||
|
[x] Collection
|
||||||
|
- [ ] Implement default SocketDef collection name
|
||||||
|
|
||||||
|
[x] Image
|
||||||
|
- [ ] Implement default SocketDef image name
|
||||||
|
|
||||||
|
[x] GeoNodes
|
||||||
|
- [ ] Implement default SocketDef geonodes name
|
||||||
|
[x] Text
|
||||||
|
- [ ] Implement default SocketDef object name
|
||||||
|
|
||||||
|
## Maxwell
|
||||||
|
[x] Bound Conds
|
||||||
|
[ ] Bound Cond
|
||||||
|
|
||||||
|
[x] Medium
|
||||||
|
[ ] Medium Non-Linearity
|
||||||
|
|
||||||
|
[x] Source
|
||||||
|
[ ] Temporal Shape
|
||||||
|
- [ ] Sane-default pulses for easy access.
|
||||||
|
|
||||||
|
[ ] Structure
|
||||||
|
[ ] Monitor
|
||||||
|
|
||||||
|
[ ] FDTD Sim
|
||||||
|
[ ] Sim Domain
|
||||||
|
- [?] Toggleable option to sync the simulation time duration to the scene end time (how to handle FPS vs time-step? Should we adjust the FPS such that there is one time step per frame, while keeping the definition of "second" aligned to a unit system?)
|
||||||
|
[ ] Sim Grid
|
||||||
|
[ ] Sim Grid Axis
|
||||||
|
|
||||||
|
[ ] Simulation Data
|
||||||
|
|
||||||
|
## Tidy3D
|
||||||
|
[x] Cloud Task
|
||||||
|
- [ ] Implement switcher for API-key-having config filconfig file vs. direct entry of API key. It should be auto-filled with the config file when such a thing exists.
|
||||||
|
|
||||||
|
## Physical
|
||||||
|
[x] Unit System
|
||||||
|
- [ ] Implement more comprehensible UI; honestly, probably with the new panels (<https://developer.blender.org/docs/release_notes/4.1/python_api/>)
|
||||||
|
|
||||||
|
[x] Time
|
||||||
|
|
||||||
|
[x] Angle
|
||||||
|
[ ] Solid Angle (steradian)
|
||||||
|
|
||||||
|
[x] Frequency (hertz)
|
||||||
|
[ ] Angular Frequency (`rad*hertz`)
|
||||||
|
### Cartesian
|
||||||
|
[x] Length
|
||||||
|
[x] Area
|
||||||
|
[x] Volume
|
||||||
|
|
||||||
|
[ ] Point 1D
|
||||||
|
[ ] Point 2D
|
||||||
|
[x] Point 3D
|
||||||
|
|
||||||
|
[ ] Size 2D
|
||||||
|
[x] Size 3D
|
||||||
|
|
||||||
|
[ ] Rotation 3D
|
||||||
|
- [ ] Implement Euler methods
|
||||||
|
- [ ] Implement Quaternion methods
|
||||||
|
### Mechanical
|
||||||
|
[ ] Mass
|
||||||
|
|
||||||
|
[x] Speed
|
||||||
|
[ ] Velocity 3D
|
||||||
|
[x] Acceleration Scalar
|
||||||
|
[ ] Acceleration 3D
|
||||||
|
[x] Force Scalar
|
||||||
|
[ ] Force 3D
|
||||||
|
[ ] Pressure
|
||||||
|
### Energy
|
||||||
|
[ ] Energy (joule)
|
||||||
|
[ ] Power (watt)
|
||||||
|
[ ] Temperature
|
||||||
|
### Electrodynamical
|
||||||
|
[ ] Current (ampere)
|
||||||
|
[ ] Current Density 3D
|
||||||
|
|
||||||
|
[ ] Charge (coulomb)
|
||||||
|
[ ] Voltage (volts)
|
||||||
|
[ ] Capacitance (farad)
|
||||||
|
[ ] Resistance (ohm)
|
||||||
|
[ ] Electric Conductance (siemens)
|
||||||
|
|
||||||
|
[ ] Magnetic Flux (weber)
|
||||||
|
[ ] Magnetic Flux Density (tesla)
|
||||||
|
[ ] Inductance (henry)
|
||||||
|
|
||||||
|
[ ] Electric Field 3D (`volt*meter`)
|
||||||
|
[ ] Magnetic Field 3D (tesla)
|
||||||
|
### Luminal
|
||||||
|
[ ] Luminous Intensity (candela)
|
||||||
|
[ ] Luminous Flux (lumen)
|
||||||
|
[ ] Illuminance (lux)
|
||||||
|
### Optical
|
||||||
|
[ ] Jones Polarization
|
||||||
|
[ ] Polarization (Stokes)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Style
|
||||||
|
[ ] Rethink the meaning of color and shapes in node sockets, including whether dynamic functionality is needed when it comes to socket shape (ex. it might be nice to know whether a socket is array-like or uses units).
|
||||||
|
[ ] Rethink the meaning of color and shapes in node sockets, including whether dynamic functionality is needed when it comes to socket shape.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Architecture
|
||||||
|
## Registration and Contracts
|
||||||
|
[x] Finish the contract code converting from Blender sockets to our sockets based on dimensionality and the property description.
|
||||||
|
[ ] Refactor the node category code; it's ugly.
|
||||||
|
[?] Would be nice with some kind of indicator somewhere to help set good socket descriptions when using geonodes and wanting units.
|
||||||
|
|
||||||
|
## Managed Objects
|
||||||
|
[x] Implement modifier support on the managed BL object, with special attention paid to the needs of the GeoNodes socket.
|
||||||
|
- [x] Implement preview toggling too, ex. using the relevant node tree collections
|
||||||
|
- Remember, the managed object is "dumb". It's the node's responsibility to react to any relevant `on_value_change`, and forward all state needed by the modifier to the managed obj. It's only the managed obj's responsibility to not update any modifier value that wouldn't change anything.
|
||||||
|
[ ] Implement loading the xarray-defined voxels into OpenVDB, saving it, and loading it as a managed BL object with the volume setting.
|
||||||
|
[ ] Implement basic jax-driven volume voxel processing, especially cube based slicing.
|
||||||
|
[ ] Implement jax-driven linear interpolation of volume voxels to an image texture, whose pixels are sized according to the dimensions of another managed plane object (perhaps a uniquely described Managed BL object itself).
|
||||||
|
|
||||||
|
## Utils or Services
|
||||||
|
[ ] Dedicated module for managing the interaction with the tidy3d cloud, to help nuke all the random caches out of existance.
|
||||||
|
|
||||||
|
## Node Base Class
|
||||||
|
[ ] Dedicated `draw_preview`-type draw functions for plot customizations.
|
||||||
|
- [ ] For now, previewing isn't something I think should be part of the node
|
||||||
|
[ ] Custom `@cache`/`@lru_cache`/`@cached_property` which caches by instance ID (possibly based on `beartype` or `pydantic`).
|
||||||
|
[ ] When presets are used, if a preset is selected and the user alters a preset setting, then dynamically switch the preset indicator back to "Custom" to indicate that there is no active preset
|
||||||
|
[ ] It seems that `node.inputs` and `node.outputs` allows the use of a `move` method, which may allow reordering sockets dynamically, which we should expose to the user as user-configurable ordering rules (maybe resolved with a constraint solver).
|
||||||
|
[?] Mechanism for dynamic names (ex. "Library Medium" becoming "Au Medium")
|
||||||
|
[-] Mechanism for selecting a blender object managed by a particular node.
|
||||||
|
[ ] Mechanism for ex. specially coloring a node that is currently participating in the preview.
|
||||||
|
[ ] Custom callbacks when deleting a node (in `free()`), to ex. delete all previews with the viewer node.
|
||||||
|
|
||||||
|
## Socket Base Class
|
||||||
|
[ ] A feature `use_array` which allows a socket to declare that it can be both a single value and array-like (possibly constrained to a given shape). This should also allow the SocketDef to request that the input socket be initialised as a multi-input socket, once Blender updates to support those.
|
||||||
|
- [ ] Implement a shape-selector, with a dropdown for dimensionality and an appropriate `IntegerVectorProperty` for each kind of shape (supporting also straight-up inf), which is declared to the node that supports array-likeness so it can decide how exactly to expose properties in the array-like context of things.
|
||||||
|
[ ] Make `to_socket`s no-consent to new links from `from_socket`s of differing type (we'll see if this controls the typing story enough for now, and how much we'll need capabilities in the long run)
|
||||||
|
- [?] Alternatively, reject non matching link types, and red-mark non matching capabilities?
|
||||||
|
|
||||||
|
## Many Nodes
|
||||||
|
[ ] Implement LazyValue stuff, including LazyParamValue on a new class of constant-like input nodes that really just emit ex. sympy variables.
|
||||||
|
[?] Require a Unit System for nodes that construct Tidy3D objects
|
||||||
|
[ ] Medium Features
|
||||||
|
- [ ] Accept spatial field. Else, spatial uniformity.
|
||||||
|
- [ ] Accept non-linearity. Else, linear.
|
||||||
|
- [ ] Accept space-time modulation. Else, static.
|
||||||
|
[ ] Modal Features
|
||||||
|
- [ ] ModeSpec, for use by ModeSource, ModeMonitor, ModeSolverMonitor. Data includes ModeSolverData, ModeData, ScalarModeFieldDataArray, ModeAmpsDataArray, ModeIndexDataArray, ModeSolver.
|
||||||
|
|
||||||
|
## Development Tooling
|
||||||
|
[ ] Implement `rye` support
|
||||||
|
[ ] Setup neovim to be an ideal editor
|
||||||
|
|
||||||
|
## Version Churn
|
||||||
|
[ ] Implement real StrEnum sockets, since they appear in py3.11
|
||||||
|
[ ] Think about implementing new panels where appropriate (<https://developer.blender.org/docs/release_notes/4.1/python_api/>)
|
||||||
|
[ ] Think about using the new bl4.1 file handler API to enable drag and drop creation of appropriate nodes (for importing files without hassle).
|
||||||
|
[ ] Keep an eye on our manual `__annotations__` hacking; python 3.13 is apparently fucking with it.
|
||||||
|
[ ] Plan for multi-input sockets <https://projects.blender.org/blender/blender/commit/14106150797a6ce35e006ffde18e78ea7ae67598> (for now, just use the "Combine" node and have seperate socket types for both).
|
||||||
|
[ ] Keep an eye out for volume geonodes in 4.2 (July 16, 2024), which will better allow for more complicated volume processing (we might still want/need the jax based stuff after, but let's keep it minimal just in case)
|
||||||
|
|
||||||
|
## Packaging
|
||||||
|
[ ] Allow specifying custom dir for keeping pip dependencies, so we can unify prod and dev (currently we hard-code a dev dependency path).
|
||||||
|
[ ] Refactor top-level `__init__.py` to check dependencies first. If not everything is available, it should only register a minimal addon; specifically, a message telling the user that the addon requires additional dependencies (list which), and the button to install them. When the installation is done, re-check deps and register the rest of the addon.
|
||||||
|
[ ] Use a Modal and multiline-text-like construction to print `pip install` as we install dependencies, so that the user has an idea that something is happening.
|
||||||
|
[ ] Test on Windows
|
||||||
|
|
||||||
|
## Node Tree Cache Semantics
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# TIDY3D BUGS
|
||||||
|
- Directly running `SimulationTask.get()` is bugged - it doesn't return some fields, including `created_at`. Listing tasks by folder is not broken.
|
||||||
Loading…
Reference in New Issue