-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update warning styling and links in README.md (#93)
- Loading branch information
Showing
1 changed file
with
6 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,11 @@ | ||
|  | ||
| [](https://doi.org/10.5281/zenodo.997468) | ||
|
|
||
| # Multiprocessing in pyLIMA (Warning) | ||
|
|
||
| The latest version of pyLIMA applies the multiprocessing library to parallelize aspects of its model fitting processes in order to optimize for speed. This has been tested and works under Ubuntu Linux with Python 3.11. | ||
| Users should be aware that the multiprocessing library uses a different method ('spawn') to start threads on the Mac and Windows platforms compared to the method used on Linux ('fork'), as the fork method is considered to be unsafe on these platforms. Unfortunately, this has meant that pyLIMA crashes if run under the latest version of Python (3.11) under a Mac (and likely under Windows), due to the outstanding issue with the multiprocessing library. | ||
| > [!WARNING] | ||
| > **Runing pyLIMA in multiprocessing...** | ||
| > | ||
| > The latest version of pyLIMA applies the multiprocessing library to parallelize aspects of its model fitting processes in order to optimize for speed. This has been tested and works under Ubuntu Linux with Python 3.11. | ||
| > Users should be aware that the multiprocessing library uses a different method ('spawn') to start threads on the Mac and Windows platforms compared to the method used on Linux ('fork'), as the fork method is considered to be unsafe on these platforms. Unfortunately, this has meant that pyLIMA crashes if run under the latest version of Python (3.11) under a Mac (and likely under Windows), due to the outstanding issue with the multiprocessing library. | ||
| We are currently investigating a fix for this issue. In the interim we recommend using an earlier version of Python with the latest pyLIMA. | ||
|
|
||
| # pyLIMA | ||
|
|
@@ -60,4 +61,4 @@ Example_5 : [HOW TO FIT PARALLAX?](https://github.com/ebachelet/pyLIMA/tree/mast | |
| # How to contribute? | ||
|
|
||
| Want to contribute? Bug detections? Comments? | ||
| Please email us ([email protected]) or raise an issue (recommended). | ||
| Please email us ([email protected]) or [raise an issue](https://github.com/ebachelet/pyLIMA/issues) (recommended). | ||