Skip to content
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

[DOC] Document more env vars? #71

Open
leofang opened this issue Jul 26, 2021 · 3 comments
Open

[DOC] Document more env vars? #71

leofang opened this issue Jul 26, 2021 · 3 comments
Assignees

Comments

@leofang
Copy link
Member

leofang commented Jul 26, 2021

We should make a distinction between env vars used at build time and those used at runtime. Runtime env vars include:

  • MPI4PY_FUTURES_MAX_WORKERS (now documented!)
  • MPI4PY_FUTURES_SERVICE
  • MPI4PY_FUTURES_SERVER_HOST
  • MPI4PY_FUTURES_SERVER_BIND
  • MPI4PY_FUTURES_SERVER_PORT

and build time env vars include:

Some of them are not mpi4py's env vars, but maybe worth mentioning?

@leofang
Copy link
Member Author

leofang commented Jul 26, 2021

Maybe we should also accept MPI4PY_CFG as an alias of MPICFG...

@leofang leofang self-assigned this Jul 26, 2021
@dalcinl
Copy link
Member

dalcinl commented Aug 3, 2021

  1. The envvars related to mpi4py.futures should be properly namespaced as MPI4PY_FUTURES_XXX, and the previous names should be deprecated. Let me look at this first before any attempt to further document them (see mpi4py.futures: Proper namespacing of environment variables #74). The really important one is MAX_WORKERS and its meaning and use is already documented in the mpi4py.futures section. The other variables are related to relatively obscure and not frequently used MPI dynamic process management I implemented and support just for completeness. I would rather prefer to remain silent for the time being.
  2. About the build-time environment vars, I'm not really sure. As time passes, more and more users consume mpi4py from pre-built packages, specially on Windows, so I hardly see the need to document I_MPI_ROOT, and MSMPI_XXX/CPP_HOME variables. MPICC is already documented. I would say that MPE* (used to be available within MPICH) and VT* (used to be available within Open MPI) are legacy stuff at this point. That leaves us with MPICFG. This one is not documented at all. You are right, the name sucks. Again, its use is rather specialized. Anyway, we could discuss a better name (e.g. MPI4PY_MPI_CONFIG) and add a note in the install section.

@dalcinl
Copy link
Member

dalcinl commented Aug 3, 2021

As you can see, I always find good excuses to not write documentation.

@dalcinl dalcinl changed the title Document more env vars? [DOC] Document more env vars? May 4, 2024
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