STEPbySTEPproj / Protocol_biomechanics

0 stars 1 forks source link

set standard python package structure #5

Closed aremazeilles closed 3 years ago

aremazeilles commented 3 years ago

I propose to use a standard package structure, which ease the installation, and also the use of the entry point, run_protocol_1. I had to change a bit run_pi_mocap_metrics.py, as you are opening local files, which needed to be a bit more generic: if we installe the python package, the script run_protool_1could be launched from anywhere.

You can see the suggested changes through the "Files changes" area above

dborro commented 3 years ago

Hi, I guess all instructions in readme file are for Linux, isn't it? I say this because I tried in Windows and I have the following issues:

aremazeilles commented 3 years ago

effectively the command I suggested to add is for Linux, which is the target platform onto which development will be run. Actually, the docker image is for such environment as well. If you want I can add a comment on this aspect in the readme.

The good part of the python package structure proposed is that, by installing it (and using the virtual environment), the python script run_protocol_1 is then accessible from anywhere. The fact that you have to state the full relative path indicates that the package is not installed. Might be an equivalent command existing from an anaconda space.

If you want I can adjust doc to state commands from windows (through conda), and from linux. But I cannot state how to install the package from conda in windows, as I am not using such tools to run scripts.

dborro commented 3 years ago

Ok. Don’t worry Anthony. As you say, if your platform is based on Linux, go head. There is no need to change the doc/readme. I just told you for your knowledge, just in case. Regards, Diego

From: Anthony Remazeilles notifications@github.com Sent: miércoles, 24 de febrero de 2021 16:19 To: STEPbySTEPproj/Protocol_biomechanics Protocol_biomechanics@noreply.github.com Cc: Borro, Diego dborro@ceit.es; State change state_change@noreply.github.com Subject: Re: [STEPbySTEPproj/Protocol_biomechanics] set standard python package structure (#5)

effectively the command I suggested to add is for Linux, which is the target platform onto which development will be run. Actually, the docker image is for such environment as well. If you want I can add a comment on this aspect in the readme.

The good part of the python package structure proposed is that, by installing it (and using the virtual environment), the python script run_protocol_1 is then accessible from anywhere. The fact that you have to state the full relative path indicates that the package is not installed. Might be an equivalent command existing from an anaconda space.

If you want I can adjust doc to state commands from windows (through conda), and from linux. But I cannot state how to install the package from conda in windows, as I am not using such tools to run scripts.

— You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHubhttps://github.com/STEPbySTEPproj/Protocol_biomechanics/pull/5#issuecomment-785149123, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ARTAMYNX4GY4IBGPUE6WPGTTAUKGPANCNFSM4YCAMSBA.

Este mensaje puede contener información confidencial. Si usted no es el destinatario del mismo o lo ha recibido por error, por favor, bórrelo de sus sistemas y comuníquelo a la mayor brevedad al remitente. Los datos personales incluidos en los correos electrónicos que intercambie con el personal de Ceit podrán ser almacenados en la libreta de direcciones de su interlocutor y/o en los servidores de Ceit durante el tiempo fijado en su política interna de conservación de información. Ceit gestiona dichos datos con fines meramente operativos, para permitir el contacto por email entre sus trabajadores/colaboradores y terceros. Puede consultar la Política de Privacidad de Ceit en la dirección: https://ceit.es/es/informacion-legal

Mezu honek isilpeko informazioa izan dezake. Mezuaren hartzailea ez bazara edo akats baten ondorioz jaso baduzu, ezaba ezazu zure sistemetatik, mesedez, eta eman horren berri igorleari. Ceit-eko langileekin trukatutako mezu elektronikoetako datu pertsonalak solaskidearen helbide-libretan eta Ceit-en zerbitzarietan gorde daitezke denbora batez; epe hori Ceit-ek informazioa gordetzeari buruz duen barne-politikan zehazten da. Ceit-ek laneko eginkizunetarako soilik kudeatzen ditu datu horiek, bere langileen eta kolaboratzaileen eta hirugarren batzuen artean posta elektroniko bidezko harremana bideratzeko. Helbide honetan duzu Ceit-eko pribatutasun-politika https://ceit.es/es/informacion-legal

This email message may contain confidential information. If you are not the intended recipient of this message or their agent, or if this message has been addressed to you in error, please immediately alert the sender by reply email and then delete this message and any attachments. The personal information included in email messages exchanged with employees of Ceit may be stored in the database of your interlocutor and/or the servers of Ceit for the time-period stipulated by its internal information storage policy. Ceit stores such data for purely administrative purposes, to facilitate e-mail contact between its employees and third parties. The Ceit Privacy Policy may be accessed at https://ceit.es/es/informacion-legal

Antes de imprimir este mensaje o sus documentos anexos, asegúrese de que es necesario. Proteger el medio ambiente está en nuestras manos.

Mezu hau edo erantsita dituen dokumentuak inprimatu aurretik, ziurtatu beharrezkoa dela. Ingurumena babestea gure esku dago.

Before printing this e-mail or attachments, be sure it is necessary. It is in our hands to protect the environment.