43 Commits
Author SHA1 Message Date
levita_a 289182f3f3 Update the documentation to include the example for adjusting learning rates per-parameter 2026-07-23 15:05:23 +02:00
allevitan 310f78e362 Update the docs to point to readthedocs 2026-07-23 09:03:41 +02:00
allevitan 6af72e1ce0 Update the docs to include the new example for loading and viewing a ptychography reconstruction 2026-06-16 16:13:51 +02:00
allevitan 4d360f1361 Update all referencs in the examples documentation to follow the new pattern 2026-06-16 16:08:17 +02:00
allevitan dd31c39dc4 Add info on loading datasets to the tutorial 2026-06-16 16:03:40 +02:00
allevitan d8fade9f32 Update the amplitude MSE and intensity MSE loss to act equivalently - currently, the intensity MSE loss was by default a mean, but amplitude was by default a sum. Both functions now have a flag, use_sum=False, which is False by default. This changes the default behavior of amplitude_mse. All models, including the tutorial version of simple_ptycho, are updated accordingly and test coverage was added. 2026-04-13 14:34:23 +02:00
allevitanandClaude Sonnet 4.6 fd17ae30ba Update tutorial to use loss instance attribute pattern
Updates tutorial_simple_ptycho.py to match simple_ptycho.py: removes
the def loss() method and instead assigns self.loss and
self.loss_normalizer as instance attributes in __init__.

Updates tutorial.rst accordingly: adds the loss assignment to the
__init__ code block with an explanation, and removes def loss() from
the forward model section.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-04-03 18:44:04 +02:00
Abe Levitan 3f028e2fbf Merge pull request #72 from cdtools-developers/feature/betterplots
A bunch of long overdue updates to the plotting system
2026-04-03 18:23:41 +02:00
allevitan 05bdee3861 Update the docs so it doesn't always think it's v0.2.0 2026-04-03 15:24:50 +02:00
allevitan 0bd8df498c Updated the documentation to reflect the changes to the plotting system 2026-03-24 21:39:04 +01:00
gnzng 444b56b829 docs: update installation instructions for dependencies to include pip 2025-11-16 11:21:36 -06:00
gnzng 4d18171e59 docs: add instructions for building custom documentation 2025-11-16 11:00:33 -06:00
gnzng 11ed3df35e ending python 3.8 support, adding python 3.14 to automatic test 2025-11-11 14:33:55 -06:00
gnzng 728cf9d590 update readme and installation docs 2025-11-10 12:23:25 -08:00
levita_a 8328b852d3 Update the docs to include the reconstructors class and discuss their use in the examples 2025-10-16 14:43:04 +02:00
levita_a ab30afb10e Update the documentation to reflect the existence of a PyPI package 2025-07-02 15:04:39 +02:00
gnzng e1b76f0959 DOCS: Force-Push due to rebasing unnecessary large commits to just add an extra doc publishing action 2025-03-03 10:11:20 -08:00
Damian Guenzing b39cd2b705 updated installation.rst for pip installation 2025-02-26 15:24:29 +00:00
levita_a 2f16c43a11 Add an MIT license to the repo to prep for open release 2024-10-10 17:26:28 +02:00
levita_a 1052d5bcb6 Move documentation to the new organization 2024-09-02 14:23:59 +02:00
Abe Levitan 13a2ba86df Make big changes to docs to update the tutorial section, and also to finally autoload the documentation of the models and datasets 2024-09-01 13:04:28 +02:00
levita_a 7b2509cfe1 remove useless old examples, and update the examples and docs to be useful for the current version 2024-02-26 17:56:19 +01:00
levita_a d7c7e8f396 start getting the docs back up to date 2024-02-23 16:54:48 +01:00
levita_a a9e0157707 Get tests to past and removeopt_for_fft 2023-12-01 15:58:18 +01:00
Abe Levitan 9f341fb4bd update the requirements files and fix a bug that prevented install when not in developer mode 2023-01-13 11:59:07 -08:00
Abe Levitan 858d8f3b2a Make edits to the docs to handle the lowercaseness of cdtools now 2022-06-08 13:30:49 -07:00
Abe Levitan b8500bd5a8 renaming 2022-06-08 13:12:50 -07:00
Abe Levitan 442fa2c71f move to a src directory layout 2022-06-08 12:09:03 -07:00
Abe Levitan 3e72243a50 Update the docs a bit 2021-07-06 14:55:29 -04:00
Abe Levitan 53cd966c33 Update the RPI model and clean up the examples section 2021-07-06 13:58:00 -04:00
Abe Levitan 8ddcc7683f Start cleaning up the repo and tidying up the example scripts 2021-06-28 11:14:41 -04:00
Abraham Levitan 59f6d58ea6 Fix typo in tutorial 2020-04-07 10:08:27 -04:00
Abraham Levitan abdd0d6e1e Update docs so that they can produce a latex/pdf version as well 2019-12-16 12:40:41 -05:00
Abraham Levitan f78a39daf5 add the test for simple_ptycho_model' 2019-10-07 15:44:17 -04:00
Abe Levitan 120e23ef15 Write the model and dataset tutorials, update the dependencies, and various small bug fixes 2019-10-04 16:53:22 -04:00
Abe Levitan 69be77cc09 Update installation instructions for simplicity and also fix the tests to reflect new usage 2019-10-02 15:56:48 -04:00
Abe Levitan 185fde27a0 More work on documentation 2019-09-11 17:56:54 -04:00
Abe Levitan 40998908f1 refactor datasets, wrote more docs, added one more test dataset 2019-09-09 14:16:42 -04:00
Abe Levitan 99d02f95cf Finish fleshing out the examples 2019-09-04 18:23:34 -04:00
Abe Levitan 5b521da557 Add the publishing script so we can publish the docs to github pages on the enterprise server 2019-09-04 16:37:30 -04:00
Abe Levitan e80bf05f25 Further improve docs layout and add unfinished ptycho models to repo 2019-09-04 16:27:55 -04:00
Abe Levitan de186592cb Update the docstrings on all the tools files and start laying out the docs for real 2019-09-03 18:49:45 -04:00
Abe Levitan d2c07bf1ac Add a tool to look at raw data 2019-08-15 12:16:43 -04:00