Skip to content

TopDirectory in Bertini #3784

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mahrud opened this issue May 7, 2025 · 1 comment
Open

TopDirectory in Bertini #3784

mahrud opened this issue May 7, 2025 · 1 comment

Comments

@mahrud
Copy link
Member

mahrud commented May 7, 2025

The way the package is set up, it fixes some global variables upon load:

--##########################################################################--
-- GLOBAL VARIABLES
--##########################################################################--
DBG = 0 -- debug level (10=keep temp files)
BERTINIexe=(options Bertini).Configuration#"BERTINIexecutable"
BERTINIderandomize = member("--no-randomize",commandLine)
--needsPackage"NAGtypes"
needsPackage "SimpleDoc"
storeBM2Files = temporaryFileName();
makeDirectory storeBM2Files
-- Bertini interface for M2
-- used by ../NumericalAlgebraicGeometry.m2

Then, for instance, storeBM2Files gets used as default value of options:

bertiniUserHomotopy = method(TypicalValue => List, Options=>{
Verbose=>false,
OutputStyle=>"OutPoints",--{"OutPoints","OutSolutions","OutNone"}--The output can be lists of Points (A muteable hash table), or lists of Solutions (list of complex numbers that are coordinates), or can be None (All information is stored on as a text file in the directory where the computation was ran).
TopDirectory=>storeBM2Files,

Which results in the documentation changing every time:

TopDirectory => ..., default value "/tmp/M2-2629113-0/0", Option to change directory for file storage.

It's not the worst thing, but also not ideal I would think.

cc: @antonleykin

@antonleykin
Copy link
Contributor

Adding @JoseMath --- we should avoid documentation mutation without necessity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants