further migration in progress

flexcompute · Jun 14, 2024 · 02e8902 · 02e8902
1 parent 3f95ab0
commit 02e8902
Show file tree

Hide file tree

Showing 90 changed files with 55 additions and 58 deletions.
diff --git a/docs/api/_custom_autosummary/attrs.rst b/docs/api/_custom_autosummary/attrs.rst
diff --git a/docs/api/_custom_autosummary/copy.rst b/docs/api/_custom_autosummary/copy.rst
diff --git a/docs/api/_custom_autosummary/json.rst b/docs/api/_custom_autosummary/json.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.components.base.Tidy3dBaseModel.from_file.rst b/docs/api/_custom_autosummary/tidy3d.components.base.Tidy3dBaseModel.from_file.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.CMCUBE.rst b/docs/api/_custom_autosummary/tidy3d.constants.CMCUBE.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.CONDUCTIVITY.rst b/docs/api/_custom_autosummary/tidy3d.constants.CONDUCTIVITY.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.C_0.rst b/docs/api/_custom_autosummary/tidy3d.constants.C_0.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.ELECTRON_VOLT.rst b/docs/api/_custom_autosummary/tidy3d.constants.ELECTRON_VOLT.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.EPSILON_0.rst b/docs/api/_custom_autosummary/tidy3d.constants.EPSILON_0.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.ETA_0.rst b/docs/api/_custom_autosummary/tidy3d.constants.ETA_0.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.GLANCING_CUTOFF.rst b/docs/api/_custom_autosummary/tidy3d.constants.GLANCING_CUTOFF.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.HBAR.rst b/docs/api/_custom_autosummary/tidy3d.constants.HBAR.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.HEAT_FLUX.rst b/docs/api/_custom_autosummary/tidy3d.constants.HEAT_FLUX.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.HEAT_TRANSFER_COEFF.rst b/docs/api/_custom_autosummary/tidy3d.constants.HEAT_TRANSFER_COEFF.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.HERTZ.rst b/docs/api/_custom_autosummary/tidy3d.constants.HERTZ.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.KELVIN.rst b/docs/api/_custom_autosummary/tidy3d.constants.KELVIN.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.K_B.rst b/docs/api/_custom_autosummary/tidy3d.constants.K_B.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.LARGE_NUMBER.rst b/docs/api/_custom_autosummary/tidy3d.constants.LARGE_NUMBER.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.METER.rst b/docs/api/_custom_autosummary/tidy3d.constants.METER.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.MICROMETER.rst b/docs/api/_custom_autosummary/tidy3d.constants.MICROMETER.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.MU_0.rst b/docs/api/_custom_autosummary/tidy3d.constants.MU_0.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.NANOMETER.rst b/docs/api/_custom_autosummary/tidy3d.constants.NANOMETER.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.PERCMCUBE.rst b/docs/api/_custom_autosummary/tidy3d.constants.PERCMCUBE.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.PERMITTIVITY.rst b/docs/api/_custom_autosummary/tidy3d.constants.PERMITTIVITY.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.PICOSECOND.rst b/docs/api/_custom_autosummary/tidy3d.constants.PICOSECOND.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.PML_SIGMA.rst b/docs/api/_custom_autosummary/tidy3d.constants.PML_SIGMA.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.Q_e.rst b/docs/api/_custom_autosummary/tidy3d.constants.Q_e.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.RADIAN.rst b/docs/api/_custom_autosummary/tidy3d.constants.RADIAN.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.RADPERSEC.rst b/docs/api/_custom_autosummary/tidy3d.constants.RADPERSEC.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.SECOND.rst b/docs/api/_custom_autosummary/tidy3d.constants.SECOND.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.SPECIFIC_HEAT_CAPACITY.rst b/docs/api/_custom_autosummary/tidy3d.constants.SPECIFIC_HEAT_CAPACITY.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.TERAHERTZ.rst b/docs/api/_custom_autosummary/tidy3d.constants.TERAHERTZ.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.THERMAL_CONDUCTIVITY.rst b/docs/api/_custom_autosummary/tidy3d.constants.THERMAL_CONDUCTIVITY.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.VOLT.rst b/docs/api/_custom_autosummary/tidy3d.constants.VOLT.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.VOLUMETRIC_HEAT_RATE.rst b/docs/api/_custom_autosummary/tidy3d.constants.VOLUMETRIC_HEAT_RATE.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.WATT.rst b/docs/api/_custom_autosummary/tidy3d.constants.WATT.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.dp_eps.rst b/docs/api/_custom_autosummary/tidy3d.constants.dp_eps.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.fp_eps.rst b/docs/api/_custom_autosummary/tidy3d.constants.fp_eps.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.inf.rst b/docs/api/_custom_autosummary/tidy3d.constants.inf.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.constants.pec_val.rst b/docs/api/_custom_autosummary/tidy3d.constants.pec_val.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.log.rst b/docs/api/_custom_autosummary/tidy3d.log.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.adjoint.web.run.rst b/docs/api/_custom_autosummary/tidy3d.plugins.adjoint.web.run.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.adjoint.web.run_async.rst b/docs/api/_custom_autosummary/tidy3d.plugins.adjoint.web.run_async.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.autograd.functions.convolve.rst b/docs/api/_custom_autosummary/tidy3d.plugins.autograd.functions.convolve.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.autograd.functions.grey_closing.rst b/docs/api/_custom_autosummary/tidy3d.plugins.autograd.functions.grey_closing.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.autograd.functions.grey_dilation.rst b/docs/api/_custom_autosummary/tidy3d.plugins.autograd.functions.grey_dilation.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.autograd.functions.grey_erosion.rst b/docs/api/_custom_autosummary/tidy3d.plugins.autograd.functions.grey_erosion.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.autograd.functions.grey_opening.rst b/docs/api/_custom_autosummary/tidy3d.plugins.autograd.functions.grey_opening.rst
diff --git a/...custom_autosummary/tidy3d.plugins.autograd.functions.morphological_gradient.rst b/...custom_autosummary/tidy3d.plugins.autograd.functions.morphological_gradient.rst
diff --git a/...tosummary/tidy3d.plugins.autograd.functions.morphological_gradient_external.rst b/...tosummary/tidy3d.plugins.autograd.functions.morphological_gradient_external.rst
diff --git a/...tosummary/tidy3d.plugins.autograd.functions.morphological_gradient_internal.rst b/...tosummary/tidy3d.plugins.autograd.functions.morphological_gradient_internal.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.autograd.functions.pad.rst b/docs/api/_custom_autosummary/tidy3d.plugins.autograd.functions.pad.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.autograd.functions.rescale.rst b/docs/api/_custom_autosummary/tidy3d.plugins.autograd.functions.rescale.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.autograd.functions.threshold.rst b/docs/api/_custom_autosummary/tidy3d.plugins.autograd.functions.threshold.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.autograd.invdes.get_kernel_size_px.rst b/docs/api/_custom_autosummary/tidy3d.plugins.autograd.invdes.get_kernel_size_px.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.autograd.invdes.grey_indicator.rst b/docs/api/_custom_autosummary/tidy3d.plugins.autograd.invdes.grey_indicator.rst
diff --git a/...api/_custom_autosummary/tidy3d.plugins.autograd.invdes.make_circular_filter.rst b/...api/_custom_autosummary/tidy3d.plugins.autograd.invdes.make_circular_filter.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.autograd.invdes.make_conic_filter.rst b/docs/api/_custom_autosummary/tidy3d.plugins.autograd.invdes.make_conic_filter.rst
diff --git a/...i/_custom_autosummary/tidy3d.plugins.autograd.invdes.make_curvature_penalty.rst b/...i/_custom_autosummary/tidy3d.plugins.autograd.invdes.make_curvature_penalty.rst
diff --git a/...om_autosummary/tidy3d.plugins.autograd.invdes.make_erosion_dilation_penalty.rst b/...om_autosummary/tidy3d.plugins.autograd.invdes.make_erosion_dilation_penalty.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.autograd.invdes.make_filter.rst b/docs/api/_custom_autosummary/tidy3d.plugins.autograd.invdes.make_filter.rst
diff --git a/.../_custom_autosummary/tidy3d.plugins.autograd.invdes.make_filter_and_project.rst b/.../_custom_autosummary/tidy3d.plugins.autograd.invdes.make_filter_and_project.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.autograd.invdes.ramp_projection.rst b/docs/api/_custom_autosummary/tidy3d.plugins.autograd.invdes.ramp_projection.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.autograd.invdes.tanh_projection.rst b/docs/api/_custom_autosummary/tidy3d.plugins.autograd.invdes.tanh_projection.rst
diff --git a/.../api/_custom_autosummary/tidy3d.plugins.autograd.primitives.gaussian_filter.rst b/.../api/_custom_autosummary/tidy3d.plugins.autograd.primitives.gaussian_filter.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.dispersion.web.run.rst b/docs/api/_custom_autosummary/tidy3d.plugins.dispersion.web.run.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.invdes.utils.get_amps.rst b/docs/api/_custom_autosummary/tidy3d.plugins.invdes.utils.get_amps.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.invdes.utils.get_field_component.rst b/docs/api/_custom_autosummary/tidy3d.plugins.invdes.utils.get_field_component.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.invdes.utils.get_intensity.rst b/docs/api/_custom_autosummary/tidy3d.plugins.invdes.utils.get_intensity.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.invdes.utils.get_phase.rst b/docs/api/_custom_autosummary/tidy3d.plugins.invdes.utils.get_phase.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.invdes.utils.sum_abs_squared.rst b/docs/api/_custom_autosummary/tidy3d.plugins.invdes.utils.sum_abs_squared.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.plugins.invdes.utils.sum_array.rst b/docs/api/_custom_autosummary/tidy3d.plugins.invdes.utils.sum_array.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.web.api.asynchronous.run_async.rst b/docs/api/_custom_autosummary/tidy3d.web.api.asynchronous.run_async.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.web.api.webapi.delete.rst b/docs/api/_custom_autosummary/tidy3d.web.api.webapi.delete.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.web.api.webapi.download.rst b/docs/api/_custom_autosummary/tidy3d.web.api.webapi.download.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.web.api.webapi.download_json.rst b/docs/api/_custom_autosummary/tidy3d.web.api.webapi.download_json.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.web.api.webapi.download_log.rst b/docs/api/_custom_autosummary/tidy3d.web.api.webapi.download_log.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.web.api.webapi.estimate_cost.rst b/docs/api/_custom_autosummary/tidy3d.web.api.webapi.estimate_cost.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.web.api.webapi.get_info.rst b/docs/api/_custom_autosummary/tidy3d.web.api.webapi.get_info.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.web.api.webapi.load.rst b/docs/api/_custom_autosummary/tidy3d.web.api.webapi.load.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.web.api.webapi.load_simulation.rst b/docs/api/_custom_autosummary/tidy3d.web.api.webapi.load_simulation.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.web.api.webapi.monitor.rst b/docs/api/_custom_autosummary/tidy3d.web.api.webapi.monitor.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.web.api.webapi.real_cost.rst b/docs/api/_custom_autosummary/tidy3d.web.api.webapi.real_cost.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.web.api.webapi.run.rst b/docs/api/_custom_autosummary/tidy3d.web.api.webapi.run.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.web.api.webapi.start.rst b/docs/api/_custom_autosummary/tidy3d.web.api.webapi.start.rst
diff --git a/docs/api/_custom_autosummary/tidy3d.web.api.webapi.upload.rst b/docs/api/_custom_autosummary/tidy3d.web.api.webapi.upload.rst
diff --git a/docs/api/_custom_autosummary/trimesh.rst b/docs/api/_custom_autosummary/trimesh.rst
diff --git a/docs/development/feature_contribution.rst b/docs/development/feature_contribution.rst
diff --git a/docs/development/release/flow.rst b/docs/development/release/flow.rst
@@ -1,9 +1,29 @@
+Feature Contribution
+=====================
+
+
+
 Feature Development Workflow
 ------------------------------
 
+
+1. Create a branch off of ``develop``
+-------------------------------------
+
+Our ``pre/x.x`` branches are where new features, bug fixes, and other things get added before a major release. To switch to the ``pre/x.x`` branch:
+
+.. code-block:: bash
+
+   git checkout pre/x.x
+
+And then you can create a new branch from here with your GitHub username pre-pended:
+
+.. code-block:: bash
+
+   git checkout -b myusername/cool-feature
+
 Currently most of our release development flow is made under the latest ``pre/*`` branch under the main frontend
-tidy3d repository. You want to fork from this latest branch to develop your feature in order for it to be included
-under that release.
+tidy3d repository. You want to fork from this latest branch to develop your feature in order for it to be included under that release.
 
 We are using a variation of the `gitflow
 workflow <https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow>`__
@@ -35,10 +55,26 @@ a clean branch on your machine.
    git pull origin pre/x.x
    git checkout -b my_name/new_feature
 
+2. Writing code
+---------------
+
+Develop your code in this new branch, committing your changes when it seems like a natural time to “save your progress”.
+
+If you are working on a new feature, make sure you add a line in the `CHANGELOG.md <https://github.com/flexcompute/Tidy3D-client-revamp/blob/develop/CHANGELOG.md>`_ file (if it exists in that repository) to summarize your changes.
+
 
 Create your feature rebase
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+3. Create a pull request on GitHub
+-----------------------------------
+
+First, push your changes to your branch on GitHub.
+
+In the GitHub website, create a pull request to merge your branch into ``pre/x.x``.
+
+Write some comments or a summary of changes in your pull request to be clear about what is being added/changed and why.
+
 Before rebasing, you should make sure you have the latest version
 of ``develop``, in case other work has been merged meanwhile.
 
@@ -81,6 +117,22 @@ rebasing has changed its history.
 Submitting to PR
 ^^^^^^^^^^^^^^^^^
 
+4. Submit for review
+--------------------
+
+Every PR must have the following before it can be merged:
+
+- At least one review.
+- A description in the CHANGELOG of what has been done.
+
+Every new major feature must also pass all of the following before it can be merged:
+
+- Frontend and backend tests by the developer (unless no code has changed on one or the other), as well as a new example notebook or a modification to an existing example notebook that utilizes the new feature. Intermediate reviews can happen, but these conditions must be met for the feature to begin to be considered for a merge.
+- Ensure any known limitations are listed at the top message in the PR conversation (e.g., does the feature work with the mode solver? The auto grid? Does it work, but not as well as it should?). The feature can be merged given the limitations if we make a decision to do that, but only if an error or warning is issued whenever a user could encounter them, and after the list has been moved to another PR or an issue to keep track.
+- If backend changes are present, review by one of the people well-versed with the solver (Momchil, Weiliang, Shashwat, Daniil).
+- If frontend changes are present, review by any member of the team and additional approval by Momchil or Tyler.
+- QA from any member of the team: playing around with the new feature and trying to find limitations. The goal is not to construct one successful example but to figure out if there is any allowed usage that may be problematic. An extra example notebook may or may not come out of this.
+
 After this, you can notify Momchil that the branch is ready to to be
 merged. In the comment you can optionally also say things like “Fixes
 #34”. This will then automatically link that PR to the particular issue,

diff --git a/docs/development/release/index.rst b/docs/development/release/index.rst
@@ -1,7 +1,7 @@
 Release Flow
 ==============
 
-This page contains all the relevant information relating to each version release process for ``tidy3d``.
+This page contains all the relevant information relating to the development cycle and each version release process for ``tidy3d``.
 
 .. You just need to make sure that the ``<same>`` branches of both ``tidy3d/`` and ``tidy3d-notebooks/`` repositories within the ``./`` and ``./docs/notebooks/`` directories are updated. The ``readthedocs`` documentation will be automatically updated through the ``sync-readthedocs-repo`` Github action.