Skip to content

Python API

Scripting interface for Sim4Life

133 Topics 414 Posts
  • Installing Additional Python Packages in Sim4Life Environment

    Solved python pip
    9
    1 Votes
    9 Posts
    711 Views
    G
    @Sylvain Yes thanks finally I succeed!
  • 1 Votes
    1 Posts
    137 Views
    No one has replied
  • Clear or Reset Geometry Workspace in Python?

    python geometry
    4
    0 Votes
    4 Posts
    662 Views
    brynB
    I typically do the following (which also clears the history and frees memory): import XCoreModeling as xcm xcm.GetActiveModel().Clear()
  • RuntimeError: Could not allocate memory for numpy array

    python numpy allocation
    3
    0 Votes
    3 Posts
    1k Views
    SylvainS
    have you tried overwriting the E_field and raw_data variables?
  • Extract the EM E field along the Spline

    3
    0 Votes
    3 Posts
    499 Views
    A
    Thank you so much for hour help with the technical issue! Your assistance made a big difference, and I truly appreciate your expertise and prompt support!
  • Max modulation tool in API

    2
    0 Votes
    2 Posts
    526 Views
    J
    Would like to know too in 2024 :)
  • Change parameters in Simulation Combiner

    2
    0 Votes
    2 Posts
    448 Views
    C
    The following example for a 2-port simulation combiner should help. i = 0 for channel in em_multi_port_simulation_combiner.GetChannelWeights(): power = [1.0, 2.0] phase = [45, 90] em_multi_port_simulation_combiner.SetChannelWeight(channel, power[i], phase[i]) i += 1 em_multi_port_simulation_combiner.UpdateAttributes() em_multi_port_simulation_combiner.Update() document.AllAlgorithms.Add(em_multi_port_simulation_combiner)
  • Geometry Modeling - Snapping to Endpoints in Python API ?

    Solved python
    3
    0 Votes
    3 Posts
    560 Views
    brynB
    Hi @dbsim4 I think it would help a lot if you could post an image depicting what you are trying to achieve. Answering the question from the subject line: No, there is no snapping in Python (not sure how that API could look like), but there are functions to get the distance between entities (and corresponding closest points), which may help. brick1 = XCoreModeling.CreateSolidBlock(Vec3(0), Vec3(1)) brick2 = XCoreModeling.CreateSolidBlock(Vec3(2), Vec3(3)) res = XCoreModeling.GetEntityEntityDistance(brick1, brick2) print(f"Distance brick1-brick2: {res[0].Distance}") print(f"Closest point on brick1: {res[0].ClosestPosition}") print(f"Closest point on brick2: {res[1].ClosestPosition}") or distance to a point: brick = XCoreModeling.CreateSolidBlock(Vec3(0), Vec3(1)) res = XCoreModeling.GetEntityEntityDistance(brick, Vec3(3)) print(f"Distance brick-point: {res.Distance}") print(f"Closest point on brick: {res.ClosestPosition}") For geometry that has end-points or corners, you could extract the vertices and again use distance wrt some other point as a way to write a script. edge = XCoreModeling.CreateEdge(Vec3(0), Vec3(1)) vertices = XCoreModeling.GetVertices(edge) assert len(vertices) == 2 for v in vertices: print(v.Position) brick = XCoreModeling.CreateSolidBlock(Vec3(0), Vec3(1)) vertices = XCoreModeling.GetVertices(edge) assert len(vertices) == 8
  • How to create solid circle ie. with surface ?

    Solved
    4
    0 Votes
    4 Posts
    499 Views
    brynB
    @dbsim4 regarding your "Update", I am not sure I understand the context. Are you trying to assign the circle loop as an edge source?
  • Refresh Matlab Expoter

    2
    0 Votes
    2 Posts
    437 Views
    brynB
    Like all entities in the Analysis pipeline, the Matlab exporter has an Update method to execute. to find more information on a specific class you can export the pipeline from the GUI as a python script use the help() function to get more information on a specific class, e.g. import s4l_v1 as s4l help(s4l.analysis.exporters.MatlabExporter)
  • Interaction with Neuron results

    2
    0 Votes
    2 Posts
    456 Views
    AntoninoMCA
    @Hüfer yes, you can access all the simulation results as well as the parameters of you EM-neuronal simulations using the Python interface. For example, you can access titration data, or the transmembrane voltage profiles stored on a point or line sensor data, etc. or you can dynamically change the stimulation pulse shape parameters (phase duration, amplitude, etc.). Sim4Life provides you already with some Python tutorials. There are at least 3 tutorials provided that show how to use Python to setup a T-Neuron simulation, how to run it and how to access the simulation results. Please have a look at these tutorials to learn Sim4Life programming (if you are a Python expert, learning will take you a day!). To access these tutorials, open the 'Scripter' panel in Sim4Life, and load one of the scripts in the folder opened when selecting "Open Example Script" clicking on the open folder button.
  • multiport sensor combiner freq normalization

    1
    0 Votes
    1 Posts
    270 Views
    No one has replied
  • This topic is deleted!

    1
    0 Votes
    1 Posts
    1 Views
    No one has replied
  • clear simulation

    2
    0 Votes
    2 Posts
    407 Views
    H
    Hi Michael, What type of simulation/solver you are running? If I understand correct, all the simulations are of the same size, but the output files are of different sizes? This should not be the case. Unless simulations have larger grids, more sensors recorded, more frequency snapshots, etc, the output file size must not change. Best, Habib
  • Specifying diameter during axon discretization

    2
    0 Votes
    2 Posts
    396 Views
    L
    I have managed to solve this. The function below seems to work def DiscretizeAxonModel(Axon_name, Diameter, type,folder): axon_entity = model.AllEntities()[Axon_name] if type=='motor': model_properties=model.MotorMrgNeuronProperties() elif type=='sensory': model_properties=model.SensoryMrgNeuronProperties() else: model_properties=model.MotorNeuronProperties() model_properties.AxonDiameter=Diameter discretized_axon = model.CreateAxonNeuron(axon_entity,model_properties) discretized_axon.Name = Axon_name +'_neuron' folder.Add(discretized_axon)
  • This topic is deleted!

    1
    0 Votes
    1 Posts
    12 Views
    No one has replied
  • This topic is deleted!

    1
    0 Votes
    1 Posts
    8 Views
    No one has replied
  • read output files

    3
    0 Votes
    3 Posts
    619 Views
    M
    solved with h5py read : import h5py with h5py.File(fname,'r') as hdf: FieldGroups=hdf['FieldGroups'] keygroup = list(FieldGroups.keys()) valField = FieldGroups[keygroup[0]] AllFields = valField['AllFields'] EMPotential = AllFields['EM Potential(x,y,z,f0)'] EMPotentialObject = EMPotential['_Object'] AdditionalFieldDataCollection = EMPotentialObject['AdditionalFieldDataCollection'] Snapshots = EMPotentialObject['Snapshots'] Potential = Snapshots['0']['comp0'] #(n, m, k, 2) numpy array PotentialData = Potential[()] ========== this can be plotted import pyvista as pv
  • How to export voxel data using python API?

    3
    0 Votes
    3 Posts
    727 Views
    M
    @montanaro I've tried it and it worked. Thank you very much!
  • one document with many simulations

    5
    0 Votes
    5 Posts
    621 Views
    M
    can you supply some code example ? thanks